phpdoc【phpdoc】PHPDoc是PEAR下面的一个非常优秀的模组，它的目标是实现类似javadoc的功能，可以为你的代码快速生成具有相互参照,索引等功能的API文档 。
基本介绍中文名：phpdoc
定义：是PEAR下面的一个非常优秀的模组
目标：实现类似javadoc的功能
编写思想：OOP的思想
功能：生成相互参照等功能的API文档
使用超类：PhpdocObject和PhpdocError
结构功能由于phpdoc本身也是符合pear的应用程式，我们首先了解一下它的结构 。phpdoc是全部採用OOP的思想来编写的，这也是PEAR所推荐的方式,phpdoc的工作原理：1. phpdoc扫描指定目录下面的php原始码，扫描其中的关键字，截取需要分析的注释，然后分析注释中的专用的tag，生成xml档案，接着根据已经分析完的类和模组的信息，建立相应的索引，生成xml档案 。2. 对于生成的xml档案，使用定製的模板输出为html档案 。从设计上来说，phpdoc使用了2个超类：PhpdocObject和PhpdocError 。这是整个PHPDOC的基本类，这种方式也是PEAR所推荐的，也就是说当你编写你自己的套用框架的时候，最好能够有一个基本的超类，而其他的子类或者是功能类都有一个共同的祖先 。在扫描原始码过程中，PHPDOC使用的是类似GREP的形式，并没有象我们通常想的那样，使用正则表达式来实现，根据作者的解释，他曾经尝试过使用正则表达式，但是资源的占用和处理速度都很难令人满意，因此採用了这种非常规的形式，具体的实现有兴趣的读者可以参看原始码 。我认为PHPDOC令人满意的另一方面是其分析结果是以XML形式保存的，这样就意味着其他的应用程式很容易可以共享这个数据，同时PHPDOC也提供了相应的接口，你可以实现这个接口，把API文档生成其他的形式，比如PDF，LATEX，WORD等等 。目前，PHPDOC的分析结果可以以HTML形式表现，以后可能会有更多的形式 。即使是HTML形式，由于使用了模板机制（他使用了PEAR的IT和ITX模组来实现），你可以很方便地定製成你自己需要的风格 。基础PHPDoc是从你的原始码的注释中生成文档，因此在给你的程式做注释的过程，也就是你编制文档的过程 。从这一点上讲，PHPdoc促使你要养成良好的编程习惯，儘量使用规範，清晰文字为你的程式做注释，同时多多少少也避免了事后编制文档和文档的更新不同步的一些问题 。编制符合PHPDoc规範的注释是非常重要的，掌握了这一点，基本上就可以利用PHPDoc为你工作了 。