PHPxref是一个能对PHP程序的代码自动生成文档的程 序。有了它,你可以看轻松的查看某个函数在哪里定义,在哪里被调用到,当然类、变量等都可以查。有了这样的工具,对于项目后期的维护是一个不可多得的助 手,也可以用来分析开源的PHP程序,比如我就用它来阅读WordPress的代码。
PHPxref是一个使用起来很简单的程序,下载下来后,把要分析的源程序放到source目录下,运行phpxref.exe(或者是 phpxref.bat,这取决于你下载的版本),结束后你在output目录下就会看到生成的文档了,相对方便。
可是,如果仅仅这样,生成的文档可能不是很好,你需要根据你要分析的程序对配置文件作一些修改,才能生成比较好的文档, 文档的可读性会更加好。下面我将分享我对WordPress进行分析时做的一些修改。
首先,修改WordPress源代码中的文件。将wp-config-sample.php重命名为wp-config.php,因为这个文件里面 有一些变量在别的文件中要使用到。
其次,修改PHPxref的配置文件。主要是对phpxref.cfg进行修改,也有其他的一些小修改,这里不列出了。
BAD_EXT=html
BAD_EXT=htm
BAD_EXT=css
BAD_EXT=js
BAD_EXT=txt
DOC_TAG=uses
DOC_TAG=since
DOC_TAG=see
DOC_TAG=access
DOC_TAG=var
DOC_TAG=deprecated
DOC_FILE_TAG=version
DOC_FILE_TAG=package
DOC_FILE_TAG=subpackage
DOC_FILE_TAG=deprecated
WP_CONTENT_DIR=wp-content/
WPINC=wp-includes/
WP_PLUGIN_DIR=wp-content/plugins/
LANGDIR=wp-content/languages/
WP_LANG_DIR=wp-content/languages/
进行以上的修改后,生成的WordPress文档就会好读多了。
如果有什么不同意见或问题,请留言给我。