PEAR：使用PHPDoc轻松建立你的PEAR文档

对于一个开发人员，文档总是最感到头疼的事情之一。而且，很可能你对待文档会采取截然不同的2种态度： 网管u家bitscn.net

当你使用别人的代码库的时候，最希望得到的是它的技术文档，尤其是当时间很紧，而你又不得不硬着头皮去读那些生涩的代码的时候。 网管网www.bitscn.com

当写你自己的程序的时候，最不希望做的事情却是给它编写专门的技术文档，你会以种种理由给自己开脱：我的代码已经足够清晰了，完全不用再为它重新编写文档了……

网管论坛bbs_bitsCN_com

也许是为了缓解这种矛盾，有很多工具可以帮助你，通过从源代码中抽取相应的注释，可以自动生成相应的api文档。java中的javadoc,perl中的pod2man。相比之下，php以前似乎缺乏相应的工具，不过，随着phpdoc的不断完善，这种局面已经大大改观。 网管下载dl.bitscn.com

在第一篇pear的编码规则中有一条，pear程序中的注释应该能够被phpdoc转换。由此可见，phpdoc在pear中的作用可不小。今天，我们将详细讨论phpdoc，这个优秀的pear程序。

网管网www_bitscn_com

PHPDoc是PEAR下面的一个非常优秀的模块，它的目标是实现类似javadoc的功能，可以为你的代码快速生成具有相互参照,索引等功能的API文档。如果你使用过javadoc生成的文档(如jdk的文档），你会非常清楚，如果你没有用过，那么下面是一个phpdoc生成它自己的文档页面的截图： 网管下载dl.bitscn.com

网管联盟bitsCN@com

网管有家bitscn.net

从图上可以知道，phpdoc生成的文档和JAVADOC很相似，它有多种的索引方式：
Packageindex:这是按照模块来索引
Classtree:这是按照你的php类的继承关系，可以生成一个树状的索引
Modulegroups:这是按照模块划分
Elementlist:这是你的所有元素（类，方法，过程/函数，变量）的字母顺序的索引