位置: 编程技术 - 正文
推荐整理分享php文档工具PHP Documentor安装与使用方法(php官方文档),希望有所帮助,仅作参考,欢迎阅读内容。
文章相关热门搜索词:php doc,php官方文档,php doctrine,php docx,php doctrine,php技术文档,php doc,php官方文档,内容如对您有帮助,希望把文章链接给更多的朋友!
本文讲述了php文档工具PHP Documentor安装与使用方法。分享给大家供大家参考,具体如下:
PHP Documentor是PEAR下面的一个模块,用来生成文档。PHP Documentor扫描指定目录下面的php源代码,扫描其中的关键字,截取需要分析的注释,然后分析注释中的专用的tag,生成html文件,接着根据已经分析完的类和模块的信息,建立相应的索引,生成html文件。在review代码的时候,有点用处。
一、安装PHP Documentor
首先要先确认一下有没有安装pear库,
如果没有安装 go-pear.php,就可以安装了。 我是用yum安装的php,安装的时候,pear已经安装了。pear安装好后,我可以通过pear install phpDocumentor来安装phpdoc
[apacheuser@krlcgcms ~]$ phpdoc -h 里面会有很多的参数,要生成html文档,有三个参数是够了。
-d 要分析的目录,多个目录用逗号分割-t 生成的文档的存放路径-o 输出的文档格式
二、生产文档
上面的这句话是说,将/tmp/test/mytest目录下的php文件,生成文档资料放到/tmp/test/doc下面,文档格式html的形势。
到存放生成文档的目录中看一下。系统没有装中文字符,所以中文乱码。
通过浏览器来看一下index.html,部分内容如果下
PHP Documentor 文档工具
1. 从上图中,我们可以看出,文档中的内容主要是把php文件中的注释标签列出来,相应的文件列出来,看着比较舒服。其他没有什么。
注释标签如下:
@author 作者信息@const 由define定义的常量@deprecate 不建议使用的API@global 全局变量@package 包信息@param 函数参数@return返回值@see 参考函数@since 引入时间@static 静态变量@var 类成员变量
2. 上图中有乱码的,生成的html的编辑是把它改成gbk就不会显示乱码的。
希望本文所述对大家PHP程序设计有所帮助。
PHP类的声明与实例化及构造方法与析构方法详解 本文实例讲述了PHP类的声明与实例化及构造方法与析构方法。分享给大家供大家参考,具体如下:phpclasshuman{publicstatic$leg=2;public$name='leo';public$age='';publ
PHP面向对象程序设计实例分析 本文实例分析了PHP面向对象程序设计方法。分享给大家供大家参考,具体如下:在对超大型项目的开发过程中,如果使用面向过程地开发,代码量是非
PHP数组游标实现对数组的各种操作详解 本文实例分析了PHP数组游标实现对数组的各种操作。分享给大家供大家参考,具体如下:如何不用foreach实现对数组实现循环答:我们只需要模拟foreach就
标签: php官方文档
本文链接地址:https://www.jiuchutong.com/biancheng/290285.html 转载请保留说明!友情链接: 武汉网站建设