php文档工具PHP Documentor安装与使用方法

前端之家收集整理的这篇文章主要介绍了php文档工具PHP Documentor安装与使用方法前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。

@H_502_0@本文讲述了PHP文档工具PHP Documentor安装与使用方法分享给大家供大家参考,具体如下:


@H_502_0@PHP Documentor是PEAR下面的一个模块,用来生成文档。PHP Documentor扫描指定目录下面的PHP代码,扫描其中的关键字,截取需要分析的注释,然后分析注释中的专用的tag,生成html文件,接着根据已经分析完的类和模块的信息,建立相应的索引,生成html文件。在review代码的时候,有点用处。


@H_502_0@

一、安装PHP Documentor


@H_502_0@首先要先确认一下有没有安装pear库,


<div class="jb51code">
<pre class="brush:xhtml;">
; UNIX: "/path1:/path2"
include_path = ".:/usr/share/pear" //pear库位置
;
; Windows: "\path1;\path2"
;include_path = ".;c:\PHP\includes"

@H_502_0@如果没有安装http://pear.PHP.net/go-pear,文件另存为一下。命令行下PHP go-pear.PHP,就可以安装了。 我是用yum安装的PHP,安装的时候,pear已经安装了。pear安装好后,我可以通过pear install PHPDocumentor来安装PHPdoc

@H_502_0@[apacheuser@krlcgcms01 ~]$ PHPdoc -h 里面会有很多的参数,要生成html文档,有三个参数是够了。

@H_502_0@-d 要分析的目录,多个目录用逗号分割 -t 生成的文档的存放路径 -o 输出的文档格式

@H_502_0@

二、生产文档

代码如下:
PHPdoc -d "/tmp/test/mytest" -t "/tmp/test/doc" -o "HTML:frames:PHPedit"

@H_502_0@上面的这句话是说,将/tmp/test/mytest目录下的PHP文件生成文档资料放到/tmp/test/doc下面,文档格式html的形势。

@H_502_0@到存放生成文档的目录中看一下。系统没有装中文字符,所以中文乱码。

@H_502_0@通过浏览器来看一下index.html,部分内容如果下

@H_502_0@

@H_502_0@

PHP Documentor 文档工具

@H_502_0@1. 从上图中,我们可以看出,文档中的内容主要是把PHP文件中的注释标签列出来,相应的文件列出来,看着比较舒服。其他没有什么。

@H_502_0@

注释标签如下

@H_502_0@@author 作者信息 @const 由define定义的常量 @deprecate 不建议使用的API @global 全局变量 @package 包信息 @param 函数参数 @return返回值 @see 参考函数 @since 引入时间 @static 静态变量 @var 类成员变量

@H_502_0@2. 上图中有乱码的,生成的html的编辑是
代码如下:
把它改成gbk就不会显示乱码的。

@H_502_0@希望本文所述对大家PHP程序设计有所帮助。

猜你在找的PHP相关文章