PHP代码分析文档生成软件

目录

几款PHP代码分析并生成文档的软件。

1. PHPXref
可以生成文档,并统计交叉索引,查找类或方法被哪些代码调用十分方便。
试过这个小工具,windows下修改配置文件制定目录和参数后,直接运行程序就能生成网页形式的文档。但最大的缺点就是,生成的网页太多,体积太大。比如15M左右的phpmyadmin源码,生成文档有170M左右。不过有压缩选项,启用压缩后体积减少到70M左右。(PS:生成的文件不知道怎么打开。)
网上有很多现成的例子,比如phpmyadmin的文档
2. phpDocumentor 或 phpDoc
非常强大的php文档生成工具。某本书中建议初学者也应该看看这个工具,要尽量使用其中推荐的注释写法,便于以后生成API文档。文档生成,没有phpxref的交叉索引功能。
phpDoc1.X版本还没用过,只装了个phpdoc2.0.0a1版。生成的文档主题足够华丽,界面绝对过硬。但alpha版本问题多多,最严重的是连接中多了个%5C(即\),导致点击所有的类链接都访问不到正确的网页,要手动该网址才行。《PHPDocumentor 2.0在winows中的下载安装方法和使用说明》提到我遇到的这个问题。
强烈建议使用phpdoc1.x版本,这个版本既有命令行又有web页面。2.X版本还是等以后出正式版再用吧。
3. Doxygen
通用的代码文档生成软件,也支持PHP语言。试着生成了一个文档,不太成功,还不会用。官方网站打不开,难道被河蟹了?