写文件是一个程序设计师最痛苦的事情之一,尤其是程序写好后有人要你把function、class等等写成一份文件。不管你是写c/c++,perl,ruby,php都不例外。
phpdocumentor是我们的就行,只要在写程序的时候,多写一点注释,范例、说明,注意一下格式,等到程序完工后,只要一个指令,就可以立刻把全部程序的说明文件产生出来,而且还有多种样式可以选择,甚至可以做成PDF,CHM。下面是安装过程。
phpDocumentor本身已经是pear的成员之一,所以安装的时候只要用pear来安装即可。安装之前先确保你的电脑上已经有php。
一、安装pear
curl -o go-pear.php http://pear.php.net/go-pear.phar
/usr/local/php/bin/php go-pear.php #执行这条命令之后按回车执行安装。
二、安装DB
下面通过pear来安装PHP-PEAR_DB库
wget download.pear.php.net/package/DB-1.7.14.tgz
pear install DB-1.7.14.tgz #安装DB库
pear install phpDocumentor #安装phpDocumentor
安装完毕。下面测试
三、测试
phpdoc -o HTML:Smarty:PHP -d /home/wwwroot/polyguide/application/controllers/app -t /home/phpdocument
#执行完毕之后就可以到/home/phpdocument目录下查看文档了。注意,打开可能是乱码。需要更改浏览器的编码格式成“UTF-8”。
命令说明:
采用 HTML:Smarty:PHP 的格式,-d后面接的是你的程序放置目录,-t是将生成的文件放在哪个目录下。如果你只要对一个文件生成的话,把-d改成-f。-f后面就是你要对哪个文件生成文档。文档的格式基本上有HTML,XML,PDF,CHM四大类别。
本篇文档是我安装的时候经由多篇博客汇聚而来。感谢@蒜容黄瓜的博客 @鸟哥のlinux
免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。