PhpDocument使用方法

有时候, 编写程序多了. 有些函数一时记不起是如何使用的. 这个时候就要经常重新打开个源文件查看个函数的使用方法. 后来多了就觉得有D麻烦. 于是就使用了PhpDocument为自己的程序生成了一份帮助文档.

注意: 我的环境是Window 7 + PHP5.2.8, 如果你的系统都是window的, 可以尝试一下. 另外, 在编写程序的时候, 要正确使用好注释. 可参考http://manual.phpdoc.org/HTMLframesConverter/default/phpDocumentor/tutorial_tags.pkg.html 了解这些注释的使用规范.

1. 在PHP安装文件夹中点击go-pear.bat安装Pear.

 

 

安装过程, 一直保持默认并回车就可以了.

1. 然后开始>执行>输入CMD打开CMD命令窗口, 然后进入你的PHP安装文件夹, 输入以下命令: pear install –o PhpDocumentor

即可下载PhpDocument. 完成后, 你可以在PHP安装目录下的PEAR目录中发现多了一个PhpDocument文件夹.

1. 完成之后就可以使用CMD命令执行生成帮助文档啦. 具体命令如下:

    

   phpdoc --parseprivate -o HTML:Smarty:PHP -d E:\project\php_project\ -t E:\project\php_project\docs

 

1. 如果你想生成CHM文件之类或其它格式的话, 把HTML:Smarty:PHP修改成对应的, 目前PhpDocument 1.4.3可以有以下几种格式:

   

2. 如果你系生成CHM的话, 你需要使用其它软件进行编译. 目前我是使用微软提供的HTML Help Workshop. 因为懒得下载, 所有就直接使用360的软件管家搜索下载安装算啦了.完成后. 执行程序, 界面如下:

   

   具体使用方法[略… ^^].

    

   最后发一个为自己库文件生成的HTML版帮助文件截图^^