很好的php文档自动生成工具ApiGen

用代码中的doc注释来生成文档,的确很省事,只要在写代码的时候,记得把doc注释写详细、规范,生成出来的文档就很好看了。

关于php的doc注释规范,可以参考这里:http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.pkg.html

之前我用phpDocumentor来做文档自动生成的,但是生成出来的文档非常不直观,找东西等不方便,如下图:

用apigen生成出来的文档就直观多了,而且定位也很方便,如图:

安装apigen参考官网http://apigen.org/:

pear channel-discover pear.apigen.org
pear channel-discover pear.nette.org
pear channel-discover pear.texy.info
pear channel-discover pear.kukulich.cz
pear channel-discover pear.andrewsville.cz

pear install apigen/ApiGen

生成文档命令示例:

apigen \
--source config/ \
--source model/ \
--source lib/ \
--source user/ \
--skip-doc-path "~/doctrine2/*"  \
--exclude "*/tests/*" \
--destination ../mxdocs/ \
--title "title"