[转]用phpxref生成PHP项目的交叉参考文档

PHPXref -PHP Cross Referencing Documentation
Generator。通过遍历项目所有的文件为PHP项目生成文档的工具,生成的文档格式支持html以及gz方式的压缩文件,同时在文档中包含项目中设计到的基类、方法、函数、变量、注释、甚至涉及到的时间表结构甚至相互include、require到的文件等等,使用中我还发现它对smarty的模板文件的支持也很好。而注释则支持PHPDocumentor风格的注释,同时支持基于javascript的客户端的搜索。phpxref是用perl编写的,对于windows平台,它自己内嵌了TinyPerl 所以无需事先安装perl。所以要做的事情大多就是:

1:下载phpxref,解压
2:把需要生成文档的PHP代码放到phpxref.cfg文件中SOURCE中指定的目录中
3:执行phpxref.pl,在windows下面是phpxref.bat或者phpxref.exe
4:用你的浏览器打开输出目录(由phpxref.cfg文件中的OUTPUT指定)中的index.html文档浏览生成的PHP项目文档。

至于PHPxref的高级应用,则可以修改phpxref.cfg来实现,每个修改项都很简单,如下便是生成一个项目的文档时的情况,其中有smarty模板的支持,以及一些错误提示。

E:\Program Files\phpxref > phpxref.exe
PHPXref 0.6
(c) Gareth Watts 2004

Processing Smarter v2…
Source………….: F:CVSRootSmarterV2Source_CodeFrontEnd
Target………….: E:Program Filesphpxrefoutput
Scanning Tree……: OK – 2838 files to process
Pass One………..:
0%..10%..20%..30%..40%..50%..60%..70%..80%..90%..100%
Generating Output..:
0%..10%..20%..30%..40%..50%..60%..70%..80%..90%..100%
Variable references:
0%..10%..20%..30%..40%..50%..60%..70%..80%..90%..100%
Function references:
0%..10%..20%..30%..40%..50%..60%..70%..80%..90%..100%
Class references…:
0%..10%..20%..30%..40%..50%..60%..70%..80%..90%..100%
Constant references:
0%..10%..20%..30%..40%..50%..60%..70%..80%..90%..100%
Table references…:

Some values were referenced in require and include statements
for which no value could be found in the configuration file so
cross-referencing
may be incomplete:
Unknown constant names (ref count): S (2), __T_MQ_PATH (1), F (19), J
(1), P (1), __INCLUDE_ROOT (19), __SETTING_STYLE (20),
__ROOT_RAM_PATH (58), __TRACKING_INCLUDE_ROOT (10), C (1), __ROOT_PATH
(1717)
Unknown variable names (ref count): $area (2), $datafile (16)

Summary statistics:
Files Scanned: 2838 containing 482226 lines
3213 variable names in 31569 definitions and 215986 references.
1255 function/method names in 3305 definitions and 39510 references.
129 constant names in 240 definitions and 3793 references.
80 class names in 154 definitions and 1583 references.
0 table names in 0 references.

Local front page URL: file://E:Program Filesphpxrefoutput/index.html

标签:bat, Function, ip, Javascript, PHP, Windows, 浏览器

*

Deepseath Modified from Green Hope Theme · Proudly powered by WordPress · 津ICP备09005418号  津公网安备 12010302001005号