一,网站根目录执行 $ composer require --dev phpdocumentor/phpdocumentor 二,进入vendor/bin/目录执行 $phpdoc -d D:\server\www\app\0.4.0\src\app\controllers\media -t D:\docs 生成文档完毕  …

官网地址:http://www.phpdoc.org/ 项目地址:https://github.com/phpDocumentor/phpDocumentor2 phpDocumentor 2是一个可以 分析php源代码和注释块并生成文档的程序. 基于phpdocumentor 1和javadoc启发而来,它持续创新的使用了一些新技术和支持php的新特性. phpDocumentor 2的特点: 兼容php5.3,全面支持命名空间和闭包等. 识别支持任何tag,以及一些追加的 (比如 @link…

PHPDocumentor是强大的代码注释生成器,本文对各个参数进行了简单地的总结: @abstract-------------使用@abstract标记来声明一个方法,类变量或类必须重新定义子类中是有效的. @abstract -------------使用@abstract标记来声明一个方法,类变量或类是抽象的.一个类中,只要有一个抽象方法,这个类必须被声明为抽象类.抽象方法在子类中必须被重写.抽象类在被继承后,其中的抽象方法不能被重写. @access-------------访问权限p…

PhpDocumentor简介 PHPDocumentor是一个用PHP写的工具,对于有规范注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档.老的版本是phpdoc,从1.3.0开始,更名为phpDocumentor,新的版本加上了对php5语法的支持,同时,可以通过在客户端浏览器上操作生成文档,文档可以转换为PDF,HTML,CHM几种形式,非常的方便. 参考介绍: 百度百科:http://baike.baidu.com/view/1269751.htm 维基百科:http…

PHPDocumentor是一个用PHP写的强大的文档自动生成工具,对于有规范注释的php程序,能够快速生成具有结构清晰.相互参照.索引等功能的API文档.旧版本是PHPDoc,PHPDoc是PEAR下面的一个非常优秀的模块,类似于Javadoc.从1.3.0开始,更名为phpDocumentor,新版本新加了对php5语法的支持,同时,可以通过在客户端浏览器上操作生成文档,文档可以转换为PDF.HTML.CHM等格式的文档,这样非常有利于代码的升级.维护.移交等. 前提:安装的前提是已经安装了…

phpDocuemtor官网:http://www.phpdoc.org/ 通过pear安装,进入dos的php目录,输入pear install -a PhpDocumentor.如果想使用web接口,则必须首先改变一个配置,参考:http://developer.51cto.com/art/200912/166582.htm. 终端:phpdoc -h   可以查看所有的指令,选几个重要的: -d     源php文件的路径 -t      生成文档后文档的存放路径(最好为其单独创建一个文件…

   PHPDocumentor是一个的用PHP写的道具,对于有规则注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档. 标记 用途 描述 @abstract   抽象类的变量和方法 @access public, private or protected 文档的访问.使用权限. @access private 表明这个文档是被保护的. @author 张三 <zhangsan@163.com> 文档作者 @copyright 名称 时间 文档版权信息 @deprecated…

给php代码添加规范的注释更多参考 http://phpdoc.org/docs/latest/index.html在phpdocumentor中,注释分为文档性注释和非文档性注释.所谓文档性注释,是那些放在特定关键字前面的多行注释,特定关键字是指能够被phpdoc分析的关键字,例如class,var等,具体的可参加附录1.那些没有在关键字前面或者不规范的注释就称作非文档性注释,这些注释将不会被phpdoc所分析,也不会出现在你产生的api文当中.3.2如何书写文档性注释:所 有的文档性注释都是…

一  缘由 最近改版公司网站和app端的api,发现很多函数和方法都没写注释,搞得每次调用之前还需要看底层实现,有的方法名和功能还类似,区分不出使用哪个最优!为了避免给后人挖坑,除了将代码写得规范外,还想自动生成api文档,方便后来人!于是就研究上了phpdocumentor.今天说下它的安装以及使用.首先需要声明的是,网站的教程很多,但问题在于,按照网上的一些教程来,坑爹,老失败.于是干脆自己动手写一篇,记录下自己的经历. 二  安装 安装的环境是win10+xampp, 1      php…

pfc: php基础类库: pecl: php扩展公共库 pear: php extension and application repository. php的扩展和应用库 phar: ['fa:], 是已经编译好了的php二进制文件 gzip是gnu zip, 是linux下的zip压缩, 比winzip更保守. 压缩率和速度要慢点?? 但是在linux世界更通用. tar + gzip = *.tgz pear的用法, 就如同yum的是一样的. 包括安装, 下载等 应用包. 也是packa…