查看完整版本: 用perl来解析你的php文档

用perl来解析你的php文档

[b]What is PhpXref ?[/b]qK6O9y/gcn4vP
PHPXref (PHP Cross Referencing Documentation Generator)，为一种开发文档生成工具，用于处理包含大量 PHP 文件的项目，为 PHP 源代码增加交叉参考，快速地为显示的 PHP 源代码添加书签链接，使得浏览源代码变得方便快速。其工作原理是遍历项目目录，将 PHP 文件的源代码翻译成可读性很强的 HTML 文件，同时加上注释，生成的结果为 HTML 文件，可使用任何浏览器进行浏览。运行只需安装 Perl 即可。4J%P{j_
AHH\

%z@}eAxb 这个在没有CVS服务器或Sub Version的环境下,phpXref不失为一个好的发布php代码,文档同步的好工具2e-d8yh+t-l

nC_:_)_9Fwd"x\ [b]PhpXref  Features[/b]
o(kP:q2Lw:Wu&Kx [oO*?F
快速,方便,需求简单} U,~2J)hW
不用任何web服务器就可以输出,
V8n'G5^0m0G e 完全匹配php的函数,classes,变量,常量,并支持包含文件.]Q|1Q)Y
JS的特性,支持跳转,搜索,历史D?6l
Z']?1C+a)O
高亮,代码提示,鼠标效果6~fVUB
完美的打印效果"Hb"ne)Lf
跨平台,从linux,*nix,win32无缝兼容.
&t?w/|q;u.TAo2t
6J2{9e3eP!m&` [b]How Get PhpXref ?[/b]
\ z.^lI
|L \5U&e u(A"U you can visit web site: http://phpxref.sourceforge.net/Jri*yZ)w4~1J
你可以从那获取到linux,win32的版本,)AmfDmn9p(|"H/d
当然默认有需要perl 解析器的支援,你也可以选择编译后exe的版本.*y)`]*NK&t^ p C@|

0?wUZ/~0j [b]How Use PhpXref ?[/b]
"~ Ot7ji/U5qW 你首先到官方网站下载最新版本的PhpXref ,这里拿win32的版本做个说明,:IN0F#e],O"EI'\ i]_F
下载回来后,解压到任何目录,G}'z%o/yr

`+n"g Izn7Ng M` 将你要产生 cross reference 的 code 复制到 source 内:[[:z pN(yPgsr WM
lrhlA*Dz
然后用编辑器打开phpxref.cfg ,
ZC
\9y2B[HT m\ 修改第10行的 SOURCE=source 你的code所在的目录,
-pp8sU4P'[F0EF 修改第14行的 OUTPUT=output 你的code输出的目录,^ bBBN1LiL
R
17行为工程的命名ROJECT=Unnamed Project v0.00
4X&EJ[3y 26行为cross reference 默认的头部 HEADERFILE=sample_header.html~4pJU,WHW,z
将编码修改为你需要的编码,
q(F4?(i)j6e6bE5U mj*` R
o_D4C0|
保存phpxref.cfg
2MCg8zM
mv
d!\xM1o%X&m!d 直接运行phpxref.exe,剩下的结果就是等待了.
5h@3R yp
k\wEeC5l"Q [code]O6~1F
D~5IvM
PHPXref 0.68qB1|8g vh#p:R
(c) Gareth Watts 2004{#kN?)Y;B0Y%J


ur z;|.kk2f`8j Processing..
[O8yWG;s B Source............: /tmp/phpxref-0.3/source
4cp-glbXB2OB Target............: /tmp/phpxref-0.3/output
/[3YP!En!KeWE Scanning Tree.....: ....................................................................r7N-`7t,Sn AS*fz?
Generating Output.: ....................................................................
i&|dOL-[8RJ Generating variable references: .......[0Z6yB9m^/Wj
Qy$Dn
Generating function references: .....
B^f4N;} Generating class references: .
.go[#E*px[1A Generating table references:6G/lYp9ZK'v$G!Lk

a`#}_ q
k/Q+JLva Summary statistics:v;s^.m&Y(XRo@R?c
Files Scanned: 68
:k;X/|^8Z
N ev,p 62 variable names in 120 definitions and 507 references.
*^ l3t|:E;@ Vl 49 function/method names in 28 definitions and 349 references.
7R S!C.Cz @*Q$C 1 class names in 2 definitions and 6 references.
|FA%T5F[ ]+?y 0 table names in 0 references.
~hh-|#]S+].VQ'X
c&`H {*X Done.
2`4Uc&e*s1V [/code]? L0J;RsXi?

v5fY%t3dx2O 发布,你将output的文档复制到任何web目录下,8R1^N@d R2mb
你可以用http://yoursite.com/output 看到php cross reference 的结果 f8M2rc6na,VM!v
7E2c6du4c3}
Some Demo !$v1WyW0?wR\+U
7rc1t|~$|1i%N
很多开源工程都设立了phpXref的镜像,
?2gm5t S 这里推荐几个,
}'Ing.J ;S4r9e6Kw+e wt

LI'PQ ^gGDVE;x Xoops cms系统 : http://xoopsforge.com/ref/language/schinese/user.php.source.html|,aBi{0a1ip0M
wordpress blog系统: http://cenamayo.com/wpxref/E*{8T ex
Tikiwiki  : http://de.tikiwiki.org/xref-BRANCH-1-9/lang/sk/language.php.source.html
yA4|p B'i} DokuWiki  : http://dev.splitbrain.org/reference/dokuwiki/nav.html?_variables/index.html
8}u/EmU 著名的开源论坛phpbb :  http://www.phpbb.de/doku/xref/nav.html?index.html
*U^5x-j.g
!O ]G|C9~sL/J 遗憾的是大陆的php开发团队,目前偶还没看到任何使用PhpXref 文档镜像的站点.
)s2cv8H&v,wE/B 在台湾的一些技术网站看到了部分的使用..

写的比较笼统，最常用的windows平台下解析php的有两种，一种是通过isapi扩展，一种是通过perl
jQ2QPEe.wz\ 我个人感觉他们俩都各有千秋，但本人更倾向于isapi扩展，优势是很大的。解析php速度快，效率高，据我所知，绝大部分的虚拟主机提供商都是通过isapi扩展方式来实现的。(B"Q bzsZV?
有想探讨问题的请联系qq：147744890