<div id="cnblogs_post_body" class="blogpost-body">
<div class="Section0">
<p class="p0">PHPDocumentor简介
PHPDocumentor是一个用PHP写的工具，对于有规范注释的PHP程序，它能够快速生成具有相互参照,索引等功能的API文档。老的版本是PHPdoc，从1.3.0开始，更名为PHPDocumentor，新的版本加上了对PHP5语法的支持，同时，可以通过在客户端浏览器上操作生成文档，文档可以转换为PDF,HTML,CHM几种形式，非常的方便。
参考介绍：百度百科：http://baike.baidu.com/view/1269751.htm
维基百科：http://en.wikipedia.org/wiki/PHPdoc
http://en.wikipedia.org/wiki/PHPDocumentor官网：http://www.PHPdoc.org/
手册文档：http://manual.PHPdoc.org/HTMLSmartyConverter/HandS/PHPDocumentor/tutorial_PHPDocumentor.pkg.html
<img src="https://www.jb51.cc/res/2019/04-01/23/51e409b11aa51c150090697429a953ed.gif" alt="复制代码">
PHP版本5.2.11
PHPsetup\PHP5
PHP.exe和PHP.ini.所在目录： PHPsetup\PHP5
运行 -> 输入cmd回车，切换到PHP.exe所在目录
修改go-pear.bat如下：
这里脚本会询问我们是否是选择服务器范围，还是本地拷贝，我们选择系统。默认就是选择系统，直接回车。
修改。回车接受，开始安装pear库。
提示我们修改PHP.ihi设置inclue_path,输入“y"回车继续安装。
自动修改PHP.ini设置include_path，就我观察，输入“Y”回车，PHP.ini并没有修改成功，这里为了保险，我们可以自己确认一遍include_path是否设置正确。
提示我们导入pear环境变量注册表文件： PHPsetup\PHP5\PEAR_ENV.reg ，我们找到该文件，双击导入注册表。回车结束安装。该文件起设置pear环境变量的作用。
PHPDocumentor前的一些准备，升级pear，可能我们安装的pear版本会有点老，故这里要升级pear。
升级完成，安装PHPDocumentor依赖包。
如果出现问题：missing structures/graph.PHP file...
PHP\pear 里面,接着进行升级或安装就没有问题了。
PHP\tmp目录里面。
升级过了。
pear install tmp/PHPDocumentor-1.4.4.tgz
PHPDocumentor
PHPDocumentor-1.4.3.tgz
提示安装成功
PHPdoc -h ，得到下图所示，就表示安装成功了。
PHPDocumentor1版本，目前已经更新到PHPDocumentor2版本了，2的安装也很简单。
第一步：安装pear（同上）
此处给出下载地址：http://pear.PHP.net/go-pear.phar
将 go-pear.phar 放到 PHP 目录下执行安装命令：
PHP go-pear
然后一路回车安装完毕。
第二步：接下来安装类关系绘图用到的工具
pear install image_graphviz
下载 http://www.graphviz.org/Download_.PHP graphviz-2.38.msi
安装后，注意环境变量 path 添加上该 bin 的路径，重启，否则无法生效
第三步：安装 phpDocumentor
稍等一会，安装步骤完成！
注意：两个安装后的目录都在PHP 下的 pear 下面：
PHP/pear/PHPDocumentor PHP/pear/
显然：version2 比version1速度快了很多。
PHPdoc
用法是
文件
文件夹里看到说明文档了
不支持中文,我们使用下面的-o HTML:Smarty:PHP选项：
PHP 的样板格式，然后原始码文件是d:\PHPsetup\PHP5\tmp\test.PHP，接着把产生的文件放在当前new目录下。
PHP 这个，因为他比较好看!
PHPDocumentor 的注解有一定的规格，但是都跟我们原来写注解的方式很像，只是要注意一下东西而已。
范例：test.PHP
class MyClass {
/**
这里是变量的说明
@var int
*/
var $a ;
/**
这里是变量的说明.
@var string 这里也可以放说明
*/
var $b ;
/**
function first ( $a ) {
return array();
}
}
?>
<div class="cnblogs_code_toolbar"><span class="cnblogs_code_copy"><a title="复制代码">
<img src="https://www.jb51.cc/res/2019/04-01/23/51e409b11aa51c150090697429a953ed.gif" alt="复制代码">
@author 程序作者名称，联络方式@const 常数
@deprecate 不建议使用的 API
@global 全域变量
@param 函数的参数
@return 回传值
@see 可参考函数
@since 开始时间
@static 静态变量
@var 物件成员变量
@todo 计划中要进行的项目
<img src="https://www.jb51.cc/res/2019/04-01/23/51e409b11aa51c150090697429a953ed.gif" alt="复制代码">
如果觉得本文有收获，记得推荐一下哦！^_^
出处：http://52fhy.cnblogs.com/
