如何安装和使用php文档工具

本文介绍了php文档工具的安装和使用。分享给大家参考，如下：

PHP Documentor是PEAR下的一个模块，用于生成文档。php Documentor扫描指定目录下的php源代码，扫描其中的关键字，截取需要分析的注释，然后分析注释中的特殊标签，生成html文件。然后，根据分析出的类和模块的信息，建立相应的索引，生成html文件。这在检查代码时很有用。

1.安装PHP Documentor。

首先，确定是否安装了梨库。

；UNIX : '/path 1:/path 2 ' include _ path=' ./usr/share/pear '/pear库位置；Windows: ' \ path1\ path 2 '；include_path='。C: \ php \包括“如果未安装http://pear.php.net/go-pear，请将文件另存为。命令行PHP go-pear.php，你可以安装它。我用yum安装了php。我装的时候，梨已经装了。pear安装后，我可以通过pear install phpDocumentor安装phpdoc。

[[emailprotected] ~]$ phpdoc -h包含许多参数。要生成html文档，三个参数就足够了。

-d要分析的目录，用逗号分隔的多个目录-t生成文档的存储路径-o输出文档格式。

二、生产文件副本代码如下：[[email protected]test]# phpdoc-d '/tmp/test/my test '-t '/tmp/test/doc '-o ' html 3360 frames 3360 pphpedit '。

上面这句话指的是目录/tmp/test/mytest中的php文件放在/tmp/test/doc下，文档格式为html的情况。

[[email protected]doc]$ lsblank.html elementindex.html Li _html classtrees _ default . html element index _html media class trees _html errors.html packages.htm L默认index.html元素index _ default . html Li _ default . html在存储生成的文档的目录中查找。系统中没有安装汉字，所以汉字乱码。

通过浏览器看index.html，如果下面有内容的话。

PHP Documentor文档工具。

1.从上图可以看出，文档中的内容主要列出了php文件中的注释标签，并列出了相应的文件，看着很舒服。没别的了。

注释标签如下：

@作者信息@const常量由define定义@弃用的API @全局全局变量@ package information @ param function parameter @ return value @参见reference function @自引入时间@static static variable @var类成员变量。

2.如果上图有乱码字符，生成的html通过复制代码编辑如下： meta http-equiv=' content-type ' content=' text/html；Charset=iso-8859-1'/将其更改为gbk，它不会显示乱码字符。

希望本文对PHP编程有所帮助。