PHP自动生成文档、代码即文档的一种思路

主要使用  ReflectionMethod,glob

PHP自动生成文档、代码即文档的一种思路_第1张图片

 

 假设 控制器目录是  /home/www/api/application/controllers/   _DIR__

$files = glob(__DIR__.'/*.php');  扫除全部的控制器文件、逐一加载至 ReflectionClass类里面、
$reflector = $m->getClass($controller); 
$classDocument = $reflector->getDocComment()   //可以拉取类的注释、
$methods = $reflector->getMethods(\ReflectionMethod::IS_PUBLIC);  //获取所有的public方法、
foreach ($methods as $method_obj) {  //逐个方法解析注释
      $docComment    = $reflector->getMethod($method_obj->name)->getDocComment();
这里取回来的是类似这种 
   /**
 * @desc 壳游戏详情
 * @apiparam {"name":"id","type":"int" ,"desc":"ID","require":"true"}
 * @return array
 */
然后你懂得、逐行解析,比如定义一些自己用的关键字、

比如  apiparam 代码入参、id,int类型的,表示ID,且必填,之后表格输出美化、

example_ret  表示出参 一串json,并逐一解释出参的意义

request_demo 表示请求实例、可以输入一串请求的地址、在对应的页面上直接请求出解锁

 }

 

PHP自动生成文档、代码即文档的一种思路_第2张图片

 

PHP自动生成文档、代码即文档的一种思路_第3张图片

PHP自动生成文档、代码即文档的一种思路_第4张图片

你可能感兴趣的:(php)