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提供的简介,特此感谢。

时间: 2024-10-06 11:51:18

PHPxref使用指南的相关文章

UI实战指南之留在电脑里的字体(一)

  进阶学习最实用教材!这一由@牛MO王涵 (BigDesign创始人/设计总监)编写的系列文章,从字体选择到提升设计感的技巧等都有涉猎,话题虽广,但全是实战过程中最关键的要素,而且是新手最关心的操作部分,学完直接上手工作 >>> 前言:我来了,这是U1系列新开篇章实战篇,不仅仅是适用于UI设计,甚至包含网页设计.平面设计.在文章中会更多的介绍一些操作上的教学,希望对新人们有帮助. 推荐字体 很多小伙伴在做设计的时候,无论是排版还是展示,都不太注重字体,或者有些太过于注重以至于用了很多种

品牌H5营销完全实战指南

那些百万PV的H5都是怎么做的?精心打造的H5要如何推广?H5技术将如何发展?本文一一为你解答 >>> 作者微信号,欢迎关注:Social Talent 对于H5这个名词想必大家已经很熟悉了,就在2014年,一项本来还不太成熟的技术在微信的社交舞台下大放异彩,让我们见识了"移动+社交"爆发的巨大能量. 然而这不是偶然,而是趋势.在具体介绍H5营销之前,我想和大家分享一份eMarketer的数据,其中显示了2012年-2018年品牌在不同媒体渠道的预算比重: 相比电视.

交互设计指南系列一:我们眼中的交互设计

交互设计(Interaction Design, 缩写 IxD 或者 IaD),是定义.设计人造系统的行为的设计领域.人造物,即人工制成物品,例如,软件.移动设备.人造环境.服务.可佩带装置以及系统的组织结构.交互设计在于定义人造物的行为方式(the "interaction",即人工制品在特定场景下的反应方式)相关的界面(Wikipedia).通过对界面和行为进行交互设计,从而可以让使用者使用人造物来完成目标,这就是交互设计的目的. 从用户角度来说,交互设计是一种如何让产品易用,有效

[翻译]JDK 8 兼容性指南

翻译官方文档,删除部分可忽略. 译者:坤谷,井桐,激酶 兼容性是一个复杂的问题. 本文介绍了Java平台潜在的三种不兼容问题: 源码: 源码兼容性问题关注Java源代码转换成class文件是否兼容,包括代码是否仍然可编译. 二进制: 在Java语言规范中,二进制兼容性定义为:"类的改变是二进制兼容的(或者不破坏二进制兼容性),是指如果改变前的类的二进制在链接时没有错误,那么改变后的类在链接时仍然没有错误." 行为 : 行为兼容性包括在运行时执行的代码的语义. 欲了解更多信息,请参阅Op

傲游浏览器快捷键必备指南

把大象放进冰箱要几个步骤?打开冰箱.把大象放进去.关上冰箱三个步骤.但如果我说傲游浏览器3快捷键,让你只需一个步骤就能把一切轻松搞定,比把大象放进冰箱还容易,你觉得可能吗?如何将这一切变成了现实?傲游浏览器快捷键必备指南帮你解答一切. 寻求帮助傲游online随时恭候--F1 按下F1会弹出帮助,使用过Windows的朋友都知道,不过傲游浏览器3提供的可是在线帮助哦.这里除了有常规的新手入门.选项设置.功能介绍.常见问题等知识普及以外,还可通过这里快速进入傲游论坛,以寻求更有针对性的解答,各种技

你不看一下吗,有一份穿衣指南需要您签收

为什么程序员喜欢穿格子衫? 因为这体现了程序员精致的生活追求.别小看一件格子衫,剪裁的难度比素色衬衫不知道高到哪里去.只要下剪和缝纫时稍有偏差,到时候格线就对不整齐.所以这也导致了格子衫良品率低,成为了精工细作的代表.而这正体现了程序员的精神:一丝不苟.   程序员穿衣指南一:合身 购买不合身的衣服就是浪费钱,买衣服一定要去商场试,仅仅在网上看图片是买不到合身的衣服的.   程序员穿衣指南二:你需要一个手领包 和女生一样,包包是一个人最重要的一件单品,没有之一!你每天上班都会用到它.男生的包包不

《阿里巴巴Java开发手册》IDEA插件与Eclipse插件使用指南

首先非常感谢大家对插件的支持与意见,这里详细介绍一下<阿里巴巴Java开发手册>IDEA插件与Eclipse插件的安装使用. 关于规约插件的背景介绍,可见上篇文章:提升团队研发效能利器,<阿里巴巴Java开发手册>插件全球首发(附插件下载地址) 一.阿里巴巴Java开发手册IDEA插件使用指南 通过Jetbrains官方仓库安装 1. 打开 Settings >> Plugins >> Browse repositories... 2. 在搜索框输入alib

Android开发者指南(25) —— Resource Types - Style

前言 本章内容为Android开发者指南的Framework Topics/Application Resources/Resource Types/Style章节,译为"样式资源",版本为Android 3.2 r1,翻译来自:"呆呆大虾",欢迎访问他的微博:"http://weibo.com/popapa",再次感谢"呆呆大虾" !期待你一起参与翻译Android的相关资料,联系我over140@gmail.com.  

搜狗输入法初学者使用指南

搜狗拼音输入法是搜狐公司(或是旗下的搜狗搜索引擎)推出的一款拼音输入法工具.它与传统方法不同的是,采用了搜索引擎技术,是第二代的输入方 法.由于采用了搜索引擎技术,速度有了质的飞跃,在词库的广度.词语的准确度上,搜狗都远远领先于其他输入方法.不过对于初学者来说,搜狗输入法还是有些 小技巧他们是不知道的,下面黑白网的小编就来说一下搜狗输入法初学者使用指南 怎样进行翻页选字? 搜狗拼音输入法默认的翻页键是"逗号(,)句号(.)",即输入拼音后,按句号(.)进行向下翻页选字,相当于PageD