PHPxref使用指南

PHPXref是一个十分优秀的PHP开发工具，它能将某一个程序（如Wordpress）中所有的函数、变量、常量等分类记录，生成一个HTML网页列表，你可以轻松地在这个列表中找到某个函数在什么位置被定义，在什么位置被引用。这一点无论是对于一个Wordpress插件开发者，还是想学习研究Wordpress的人都是十分有用的。PHPXref官方有个已经制作好的Wordpress的分析文档：http://phpxref.com/xref/wordpress/，此外，PHPXref还制作了多种PHP程序的分析文档，有兴趣的可以Google站内搜索一下。

PHPXref的主要功能包括

1.文件管理。无论要找什么文件，用它能很快地搜索到，如果你的文件中有符合语法规则的注释，PHPXref还能将它列在文件名的旁边，更容易了解这个文件的功能用途，也不用为了找一个文件翻遍整个文件夹，打开每个文件查找注释了。

2.函数、变量、常量、类管理。Wordpress内置了多种功能强大的函数、类，无论是字符处理还是远程URL读取等都有现成的函数，但我们往往不知道这个函数能在Wordpress里面找到，现在容易多了，搜索一下就找到了，如果在开发过程中遇到某个Wordpress函数，不知道它是干什么用的，这时候就得找到这个函数在哪里定义的，可是Wordpress里面上百个文件上哪找去？还是用PHPXref好了。

3.文件包含管理。Wordpress中需要很多 include，require包含别的文件，但偶尔也会遇到重复包含导致出错，虽然require_once可以解决，但我们也最好要了解某个脚本包含了哪些文件，要调用这个文件时也心中有数。PHPXref提供了每个文件的包含文件列表和被包含的文件。

4.源代码高亮。这个功能也是比较实用的，但在实际测试中偶尔会出错。

5.出色的关联功能。在浏览源代码时，将鼠标指到某个函数名，就会在鼠标旁边出现函数的定义页面，以及被使用次数，此外，还对使用较多的变量名，也是可以直接有个页面显示所有的关于这个变量的使用情况。

既然PHPxref那么强大，该如何使用呢？

1.首先，从SF下载最新的程序，现在的版本是0.7，下载那个win32的版本就好了。下载后解压出来。

2.phpxref目录下有一个 source 的文件夹，这是存放源代码的文件夹，把另外下载的Wordpress源代码放到这里来，请注意，不要把 wordpress/这整个目录放进来，而是里面的文件放进来就行了，确保以 source/index.php，source/wp-content/ ..这样的格式就行。

3.运行可执行文件phpxref.exe ，将进行生成文档的工作，这个过程大约需要1分钟左右，由于需要高频率读取硬盘和大量计算消耗CPU资源，请暂停其他工作。

4.提示成功后，output 这个目录下就是所有的文档了，建议在本地上用XAMPP进行调试，把整个output 文件夹搬到 xampp的 htdocs 的目录下，再把名字改为好记的 phpxref ，这样，就可以通过 http://localhost/phpxref/ 访问了。效果和 http://phpxref.com/xref/wordpress/ 的是一模一样，当然，速度快了很多。

PHPXref还提供了在Linux下生成文档的版本，但我很少用Ubuntu，也没有去Ubuntu下测试了，我想更多数人需要的还是Win系统下的，如果有需要，把Win下生成的文档可以搬到服务器上去供大家访问，还可以在页面下面放点Google Adsense广告赚点外快。但PHPxref生成的文档实在太大了，一个1.2MB的Wordpress(压缩包)，解压后再生成文档，居然要80多 MB的位置！压缩完后也需要接近20MB，所以我打消了把它放在自己服务器上的愿望（说不定制作重复的镜像还会被搜索引擎处罚）。

除了用PHPXref来生成已有的Wordpress或其他PHP示范程序（如Discuz）进行学习外，用PHPXref来生成自己制作的PHP 程序，进行检验错误或者是整理代码资源也很有用。我从学PHP至今大概写过5个比较大型的程序（我认为算比较大型了，但没有一个是成型的商业产品），几乎也是写了5次的邮件地址验证函数，用户名验证函数，密码验证函数，MySQL类…看来还得用PHPXref来整理资源了。

在使用PHPxref之前，我还读过awflasher.com提供的简介，特此感谢。