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

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

内容导读

互联网集市收集整理的这篇技术教程文章主要介绍了PHP自动生成文档、代码即文档的一种思路，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含911字，纯文字阅读大概需要2分钟。

内容图文

主要使用  ReflectionMethod，glob

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

 

 假设 控制器目录是  /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自动生成文档、代码即文档的一种思路 - 文章图片

 

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

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

内容总结

以上是互联网集市为您收集整理的PHP自动生成文档、代码即文档的一种思路全部内容，希望文章能够帮你解决PHP自动生成文档、代码即文档的一种思路所遇到的程序开发问题。 如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。

内容备注

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。

内容手机端

扫描二维码推送至手机访问。

本文链接：https://qyyshop.com/info/849357.html

来源：【匿名】