php通过注释自动生成文档插件

最新推荐文章于 2026-07-08 14:57:36 发布

转载最新推荐文章于 2026-07-08 14:57:36 发布 · 1.7k 阅读

收录于

当前文章被以下社区和专栏收录：

本文提供了一个使用CI控制器创建API文档的示例代码，包括构造函数初始化、API注释说明、参数定义及返回值描述，展示了如何通过API文档接口获取用户信息。

[代码] demo

view source

print ?

 
/**
 
 * @author ym
 
 * @group(name="docgroup", description="文档模块")
 
 */
 
class Doc extends CI_Controller {
 
  
 
    function __construct() {
 
        parent::__construct();
 
        $this->load->library('phpdoc/apidoc');
 
    }
 
  
 
    /**
 
     * @ApiDescription(section="User", method="get", description="Get information about user")
 
     * @ApiNotice(description="登录后，客户端要保存服务器种下的cookie来维护session")
 
     * @ApiSuccess(value="{'firstname' : 'ym', 'lastname'  : '1623', 'lastLogin' : '2014-04-21'}")
 
     * @ApiExample(value="{'username' : 'ym', 'password'  : '123456'}")
 
     * @ApiAccess(login="true")
 
     * @ApiParams(name="id", type="integer", is_selected=true, description="User id")
 
     * @ApiParams(name="sort", type="enum[asc,desc]", description="User data")
 
     * @ApiReturn(name="id", type="integer", description="User id")
 
     * @ApiReturn(name="sort", type="enum[asc,desc]", description="sort data")
 
     * @ApiReturn(name="page", type="integer", description="data of page")
 
     * @ApiReturn(name="count", type="integer", description="data of page")
 
     */
 
    function build(){
 
        $this->apidoc->build_doc();
 
    }
 
  
 
}
 参考huiyi8素材
   脚本代码：
   http://www.huiyi8.com/jiaoben/