Maison >développement back-end >tutoriel php >PHP的学习--使用PhpDocumentor 2生成API文档_PHP教程
官网地址:http://www.phpdoc.org/ 项目地址:https://github.com/phpDocumentor/phpDocumentor2
phpDocumentor 2是一个可以 分析php源代码和注释块并生成文档的程序。
基于phpdocumentor 1和javadoc启发而来,它持续创新的使用了一些新技术和支持php的新特性。
phpDocumentor 2的特点:
安装需求:
1.依赖于 pear 进行安装:
下载 pear http://pear.php.net/go-pear.phar
将 go-pear.phar 放到 PHP 目录下
执行安装命令:
php go-pear.phar
下面会执行输入 system
然后一路回车安装完毕
2.接下来安装类关系绘图用到的工具:
pear <span>install</span> image_graphviz
下载 http://www.graphviz.org/Download_windows.php graphviz-2.38.msi
安装后,注意查看环境变量 path 中是否已添加上该 bin 的路径,
下面很重要的一步:重启电脑,否则无法生效
3.安装 phpDocumentor
pear channel-discover pear.phpdoc.org <span>//</span><span>注册channel</span> pear remote-list -c phpdoc <span>//</span><span>列出可以获得的版本</span> pear <span>install</span> phpdoc/phpDocumentor <span>//</span><span>安装phpDocumentor </span>
详情参考:http://pear.phpdoc.org/
安装步骤完成!
提示下:
两个软件安装后的目录都在PHP 下的 pear 下面:
下面开始生成项目文档:
在PHP根目录下:
phpdoc -d 项目绝对路径 -t 生成的文档存放的路径d代表路径directory,t代表target。或者可以选择-f来指定单个文件。制定好路径稍等片刻执行完毕就可以在target文件夹里看到说明文档了。
例子:
phpdoc -d E:\bak\video\code -t E:\bak\video\code\doc
E:\bak\video\code 为php代码的文件夹
E:\bak\video\code\doc 为生成文档的文件夹
具体的参数如下:
project:run [-t|--target[="..."]] [-f|--filename[="..."]] [-d|--directory[="..."]] [-e|--extensions[="..."]] [-i|--ignore[="..."]] [--ignore-tags[="..."]] [--hidden] [--ignore-symlinks] [-m|--markers[="..."]] [--title[="..."]] [--force] [--validate] [--visibility[="..."]] [--defaultpackagename[="..."]] [--sourcecode] [-p|--progressbar] [--template[="..."]] [--parseprivate] [-c|--config[="..."]]