PHP的学习--使用PhpDocumentor 2生成API文档

小咪咪 2022-03-31 07:54 179阅读 0赞

官网地址： [http://www.phpdoc.org/][http_www.phpdoc.org]

项目地址： [https://github.com/phpDocumentor/phpDocumentor2][https_github.com_phpDocumentor_phpDocumentor2]

phpDocumentor 2是一个可以 分析php源代码和注释块并生成文档的程序。

基于phpdocumentor 1和javadoc启发而来，它持续创新的使用了一些新技术和支持php的新特性。

phpDocumentor 2的特点:

*  兼容php5.3，全面支持命名空间和闭包等。
 *  识别支持任何tag，以及一些追加的 (比如 @link).
 *  更快的处理速度。 较 phpDocumentor 1在Zend Framework 下的处理耗时有了明显的减少。
 *  低内存消耗，小中大型工程的内存消耗分别低于20MB,40MB和100MB。
 *  增量解析。如果你有之前运行phpdoc获得的structure.xml文件，那么小修改后重新生成文档的速度将提升80%。
 *  简单就能创建模板，只需1小步和编辑3个文件。
 *  兼容1代的命令行。例如 --directory, --file and --target
 *  两步式处理。首先生成structure文件，你可以根据这个文件来格式化相关信息，用自己的工具来展现信息!

安装需求：

*  PHP 5.3.3 or higher
 *  ext/iconv, [http://php.net/manual/en/book.iconv.php][http_php.net_manual_en_book.iconv.php] (从PHP 5.0.0版本起，默认开启)
 *  ext/intl, [http://php.net/manual/en/book.intl.php][http_php.net_manual_en_book.intl.php]
 *  The XSL extension, [http://www.php.net/manual/en/book.xsl.php][http_www.php.net_manual_en_book.xsl.php] (可选，只在使用xsl的模板时使用)
 *  Graphviz (可选，用来生成类图)

### 安装phpDocumentor 2 ###

1.依赖于 pear 进行安装：

下载 pear http://pear.php.net/go-pear.phar

将 go-pear.phar 放到 PHP 目录下

执行安装命令：

php go-pear.phar

下面会执行输入 system

然后一路回车安装完毕

2.接下来安装类关系绘图用到的工具：

pear install image_graphviz

下载 http://www.graphviz.org/Download\_windows.php**graphviz-2.38.msi**

安装后，注意查看环境变量 path 中是否已添加上该 bin 的路径，

下面很重要的一步：重启电脑，否则无法生效

3.安装 phpDocumentor

pear channel-discover pear.phpdoc.org //注册channel
    pear remote-list -c phpdoc //列出可以获得的版本
    pear install phpdoc/phpDocumentor //安装phpDocumentor

详情参考：[http://pear.phpdoc.org/][http_pear.phpdoc.org]

安装步骤完成！

提示下：

两个软件安装后的目录都在PHP 下的 pear 下面：

*  php/pear/PhpDocumentor
 *  php/pear/Image

### 使用PhpDocumentor 2 ###

下面开始生成项目文档：

在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\[="..."\]\]

[http_www.phpdoc.org]: http://www.phpdoc.org/
[https_github.com_phpDocumentor_phpDocumentor2]: https://github.com/phpDocumentor/phpDocumentor2
[http_php.net_manual_en_book.iconv.php]: http://php.net/manual/en/book.iconv.php
[http_php.net_manual_en_book.intl.php]: http://php.net/manual/en/book.intl.php
[http_www.php.net_manual_en_book.xsl.php]: http://www.php.net/manual/en/book.xsl.php
[http_pear.phpdoc.org]: http://pear.phpdoc.org/