php Documentor 1.2.2 使用说明规范

php Documentor 1.2.2 使用说明规范
2004-11-2 整理初稿

一、什么是phpDocumentor

phpDocumentor是PEAR下面的一个非常优秀的模块，它的目标是实现类似javadoc的功能，可以为你的代码快速生成具有相互参照,索引等功能的API文档。

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

phpDocumentor可以以不同的格式(包括HTML，XML和PDF)输出文档，由此进一步地减少了人工文档化的时间。当然，对于更为专业化的文档，比如用户手册或者程序流框图，你仍然需要懂得技术的人来编写。但是对于比较简单的文档和方法原型，phpDocumentor已经是一款胜任的工具。

二、 phpDocumentor的结构及功能

由于phpDocumentor本身也是符合pear的应用程序，我们首先了解一下它的结构。phpDocumentor是全部采用OOP的思想来编写的，这也是PEAR所推荐的方式, phpDocumentor的工作原理：

phpDocumentor扫描指定目录下面的php源代码，扫描其中的关键字，截取需要分析的注释，然后分析注释中的专用的tag，生成xml文件，接着根据已经分析完的类和模块的信息，建立相应的索引，生成xml文件，对于生成的xml文件，使用定制的模板输出为html文件。

从设计上来说，phpDocumentor使用了2个超类：PhpDocumentorObject和PhpDocumentorError。这是整个phpDocumentor的基本类，这种方式也是PEAR所推荐的，也就是说当你编写你自己的应用框架的时候，最好能够有一个基本的超类，而其他的子类或者是功能类都有一个共同的祖先。在扫描源代码过程中，phpDocumentor使用的是类似GREP的形式，并没有象我们通常想的那样，使用正则表达式来实现，根据作者的解释，他曾经尝试过使用正则表达式，但是资源的占用和处理速度都很难令人满意，因此采用了这种非常规的形式，具体的实现有兴趣的读者可以参看源代码。我认为phpDocumentor令人满意的另一方面是其分析结果是以XML形式保存的，这样就意味着其他的应用程序很容易可以共享这个数据，同时PhpDocumentor也提供了相应的接口，你可以实现这个接口，把API文档生成其他的形式，比如PDF，LATEX，WORD等等。目前，phpDocumentor的分析结果可以以HTML形式表现，以后可能会有更多的形式。即使是HTML形式，由于使用了模板机制（他使用了PEAR的IT和ITX模块来实现），你可以很方便地定制成你自己需要的风格，

作为“PHP的完整文档化方案”，phpDocumentor以读取源代码的注解并使用这些注解建立一个专业化的简洁的API文档。这一工具支持不同的输出格式：HTML，PDF，Windows HLP，以及XML。在每一这些输出格式中，可以使用到不同的模板和设计风格。并且你甚至可以建立你自己的模板——phpDocumentor使用这一著名的Smarty template引擎来操作数据。
三、PhpDocumentor基础

PhpDocumentor可以通过PEAR获得，PHP Extension 以及 Application Repository可以从PhpDocumentor.org中下载。

在pear下安装phpDocumentor是一件极其简单的事情，只需要在cmd窗口中cd 到php安装目录下，然后输入Pear install phpDocumentor Pear就会自己下载并完成phpDocumentor的安装。

在phpDocumentor成功安装后，php安装目录下会多出来一个phpDocumentor.bat。这个文件就是我们用来生成文档的批处理文件了。在phpDocumentor.bat所在目录下，输入PhpDocumentor –h 会得到一个phpDocumentor的详细参数列表。

我们从其中选出几个常用的来看看：
-f 要进行分析的文件名，多个文件用逗号分割
-d 要分析的目录，多个目录用逗号分割
-t 生成的文档的存放路径
-o 输出的文档格式，结构为输出格式:转换器名:模版目录，例如：HTML:frames

hpedit
其他的命令请大家阅读help的提示信息。

PhpDocumentor是从你的源代码的注释中生成文档，因此在给你的程序做注释的过程，也就是你编制文档的过程。从这一点上讲，PhpDocumentor促使你要养成良好的编程习惯，尽量使用规范，清晰文字为你的程序做注释，同时多多少少也避免了事后编制文档和文档的更新不同步的一些问题。编制符合PhpDocumentor规范的注释是非常重要的，掌握了这一点，基本上就可以利用PhpDocumentor为你工作了。

注释在PhpDocumentor中分为文档注释和非文档注释

3.1 文档注释
文档注释实际上是一些特殊形式的多行注释，一般是放在你需要注释的特定的关键字(这些关键字是指将会被phpDocumentor分析的那些关键字，相关的关键字列表请参看后面第4节的说明）前面。下面是一个文档注释的例子：

/**
* Common base class of all phpDocumentor classes （简述，用在索引列表中）
*
* As a kind of common base class PhpDocumentorObject holds
* configuration values (e.g. error handling) and debugging
* methods (e.g. introspection()). It does not have a constructor,
* so you can always inheritig PhpDocumentor classes from this
* class without any trouble. （详细的功能描述）
*
* @author Ulf Wendel
* @version $Id: PhpDocumentorObject.php,v 1.3 2001/02/18 15:29:29 uw Exp $
* @package PhpDocumentor （文档标记）
*/
class PhpDocumentorObject {
.....
}

以上的文档注释将会生成如下的文档：
<b>PhpDocumentorObject</b>

PhpDocumentorObject

Common base class of all phpDocumentor classes

<b>private class PhpDocumentorObject </b>

Common base class of all phpDocumentor classes
As a kind of common base class PhpDocumentorObject holdsconfiguration values (e.g. error
handling) and debuggingmethods (e.g. introspection()). It does not have a
constructor,so you can always inheritig PhpDocumentor classes from thisclass without any trouble.

Authors Ulf Wendel <ulf.wendel@phpDocumentor.de>
Version $Id: PhpDocumentorObject.php,v 1.3 2001/02/18 15:29:29 uw Exp $

3.2 非文档性注释
如果你的注释没有放在那些phpDocumentor指定的关键字前面，那么phpDocumentor认为你所作的这些注释是属于非文档注释，将不会被phpDocumentor所分析，也不会出现在你产生的api文当中。

3.3 如何书写你的文档性注释

从3.1 我们可以看到，一个文档性的注释，是由3个部分组成的，分别是：功能简述区，功能详细说明区，文档标记区。

首先，第一行是一个注释开始的标志"/**"，然后是回车，从第2行开始就是功能简述区，功能简述区是以缩进的"*"开始的，在简述的正文和这个"*"号之间用空格分隔（注意，在文档中，都是以*开始，并且这些*保持对齐的缩进格式）。功能简述的正文一般是简明扼要地说明这个类，方法或者函数的功能，功能简述的正文在生成的文档中将显示在索引区。

在功能简述区后面是一个空的注释行，用来分割简述区和详细说明区。功能详细说明区也是以缩进的'*"来引导的，这部分主要是详细说明你的API的功能，用途，如果可能，也可以有用法举例等等。在这部分，你应该着重阐明你的API函数或者方法的通常的用途，用法，并且指明是否是跨平台的（如果涉及到），对于和平台相关的信息，你要和那些通用的信息区别对待，通常的做法是另起一行，然后写出在某个特定平台上的注意事项或者是特别的信息，这些信息应该足够，以便你的读者能够编写相应的测试信息，比如边界条件，参数范围，断点等等。

在功能详细说明区后面，是空白的注释行，然后是文档标记区，你可以在这些书写相关的文档标记（这些文档标记的用法请参考后面的第4节），指明一些技术上的细节信息，最主要的是调用参数类型，返回值及其类型，继承关系，相关方法/函数等等。多个文档标记应该使用相同的缩进，组成一个"标记块"，便于阅读和分析。

在文档标记区下面的一行就是注释结束行"*/",注意，在注释结束标记*/后面应该直接跟一个回车，不要另外附加其他的东西，否则可能造成phpDocumentor分析出错。

以上就是书写一个文档性注释的基本方法，下面我们讨论一下书写文档时的规范和技巧。

3.4 文档书写指南

在你描述你的代码的用途或者是功能的时候，最好能够遵循大多数人的习惯，通俗地讲就是"你告诉我的信息正是我想要知道的"。为此，这里将介绍一些书写文档注释的技巧和规范，希望能够对你有所帮助：

使用 <code> 来标志关键字和命名及相关的代码。如果在文档中需要引用一些关键字，变量名，或者是你要给出一些代码的例子，那么你最好使用<code></code>来将这些关键字，变量名，代码片段和你的文档分隔开，这样，读者阅读的时候，将会知道，这些将是运行的代码，关键字而不是你的描述性的语言。
使用简单，明确的语言，避免冗长，复杂，晦涩的长句来描述。尤其是在功能简述，参数说明等索引部分中，尽量使用简单明白的语言揭示主要的信息，把其他的细节放在详细说明部分去阐述。如果你使用英语，建议使用短语而不一定是句子。

如果使用英语，建议使用第3人称单数的形式来说明，在给方法、函数说明的时候，你需要说明的是这个方法"作了什么"，而不是"怎么做"。因此，建议你的说明是以动词开始，比如"返回记录数"，"删除给定的记录"等等。

当你引用的某个对象或者变量是从当前的类中建立的，那么使用 "this" 代替 "the" 来指代那个对象或者是变量避免空话，废话，对于你所要给出的API，在你的API后面要有它的功能描述，是其能够"自成文档"。所谓的空话，废话是指，你的描述不是功能描述，而只是API名称的简单重复和罗列，或者是用另一个API来解释这个API，到头来，你的读者也不知道你所要表达的内容实质。你的描述，应该是那些从你的类名，方法名，或者是函数名看不到的补充的信息，而不是把你的API名称再重复一遍。很多人可能很多人（包括我）不知不觉中就犯了这个错误，下面是一个例子：
/**
* 设置用户记录集
*
* @param text 给定的表名
*/
function set_user_record($table) {

你从上面这段注释中能够知道什么？因此，这段注释实际上是废话，因为你从函数名称上是可以看出的，下面是改进后的：
/**
* 打开系统用户表并设置为当前用户记录集，此记录集将用于随后相关用户数据更新操作的缺省记录集。如果失败则抛出一个数据库错误。
*
* @param text 要打开的系统用户表的表名。
*/
function set_user_record($table) {

适当地使用链接，为你文档中引用的API名称（包括你的其他类及方法，PHP的函数等）添加适当的链接是很受欢迎的：你可以使用@link标记来添加到相关的API的链接，不过，你没有必要为文档中引用的所有的API都添加连接，这样会很不美观，这里有一个简单的标准：如果用户在这个地方看到某个API，确实希望要去点击以便获取更多信息，这样有助于他们去理解你的文档，并且即使添加了链接，只在它第一出现的是时候添加，没有必要重复添加相同的LINK。

由于phpDocumentor的功能限制，一个PHP文件只定义一个类或模块，不要把类和模块的定义放在同一个文件里，否则phpDocumentor可能无法工作，至少目前版本是这样。如果你的框架使用OOP来构建，应避免同时使用模块或模块组；同时应该仔细规划你的应用结构，你的应用框架应该是一个类似树型的结构，顶层的分支不要太多，例如你可以设计2个超类，分别是作为正常应用和错误处理的超类，其余的都从这2个类派生出来。

四、 phpDocumentor关键字及文档标志

4.1 关键字
class 、function 、var 、include (include_once, require, require_once) 、define

在以上这些关键字前面所做的注释，都被认为是文档性注释。

4.2 文档标记
说明：使用范围是指该标记可以用来修饰的关键字，或其他文档标记
@abstract 使用范围：class, function, var
说明当前类是一个抽象类。

注释：从PHP语言角度来说，它并不象JAVA，C++那样，支持抽象类这个概念。也没有相应的关键字来修饰某个类是抽象类。由于phpDocumentor实际上大部分是借鉴了JAVADOC的做法，因此很多文档标记也是直接从JAVADOC中沿袭过来，如abstract,access,final等等。虽然这些特性没有从语言级别得到支持，不过从使用者角度来遵循这些特性，仍是值得推荐的。

举例：
/**
* 这是一个绘五星图案的抽象类.
* @abstract
*/
class paint_start {
/**
* 绘制数量
* @abstract
*/
var $number;
/**
* 绘制五星图案
* @abstract
*/
function paint() {
;
}
}

@access (public|private) 使用范围：class, function, var, define, module

指明这个变量、类、函数/方法的存取权限。如果你的函数是内部使用，你应该指明它为private,这样的好处是，即使PHP不能阻止其他的人使用你的私有数据，但是至少你向你的用户传达这样的信息，这是一个私有的函数，因此不保证在将来的版本中仍存在；对于使用者而言，表示为@private的数据和方法，你不应该直接使用，即使你可以这样做。

举例：
/**
* 这是一个绘五星图案的抽象类.
* @abstract
* @access public
*/
class paint_start {

/**
* 绘制数量
* @abstract
* @access private
*/
var $number;

/**
* 绘制五星图案
* @abstract
* @access public
*/
function paint() {
;
}

}

@author Name [<email>] [, ...] 使用范围：class, function, var, define, module, use

指明作者信息,依次是作者姓名，email地址，其他的通讯信息。如果有多个作者，按照其先后次序，使用多个@author依次列出：

* @author Night Sailer <night@hotmail.com>
* @author Lee Tester <tester@gnome.org>
@brother (function()|$variable) 使用范围：class, function, var, define, module, use
@sister (function()|$variable) 使用范围：class, function, var, define, module, use

指出兄弟类、函数或者是变量.这些函数、类、变量等有相似的信息和并实现相同的功能。比如，调用和返回的参数的个数和类型相同，实现的功能也一样。这种情况，你可以使用@brother 或者 @sister指明它的兄弟函数，无须在重复书写函数的功能等信息了。

举例：
/**
* 这是一个绘五星图案的抽象类.
* @abstract
* @access public
*/
class paint_start {

/**
* 绘制数量
* @abstract
* @access private
*/
var $number;

/**
* 绘制五星图案
* @abstract
* @access public
*/
function paint() {
;
}

/**
* @brother paint()
*/
function draw() {
;
}

}

@const[ant] label [description] 使用范围：define
指明常量
这个标记实际上是用来说明php的define关键字定义的常量。

@copyright description 使用范围：class, function, var, module, define, use
指明版权信息。

@deprec[ated] label 使用范围：class, function, var, module, define, use
指明不推荐或者是废弃的信息.

如果你的某个函数或者方法，已经被新的函数方法替代，或者是已经废弃，不希望读者继续使用。那么你可以使用这个标志告诉读者，这个函数只是为了保持兼容性而保留的，它不被推荐使用，如果它已经被其他函数替代，也要指出这个替代者。

例子：
/**
* 过时的类
*
* @deprec 1.5-2000/12/06
* @access public
*/
function dontUseMeAnyMore() {
print "Don't use me any more. I have been deprecated.";
}

@exclude label 使用范围：class, function, var, module, define, use
指明当前的注释将不进行分析，不出现在文挡中

@final 使用范围：class, function, var
指明这是一个最终的类、方法、属性，禁止派生、修改。
举例：
/**
* 圆周率
* @final
*/
var $PI = 3.1415926;

@global (object objecttype|type) [$varname] [description] 使用范围：function
指明在此函数中引用的全局变量
举例：
/**
* Simuliert include_once in PHP 3.
*
* @global array $__used_files 已经include的文件列表
* @access public
*/
function include_once($filename) {
global $__used_files;

if (!isset($__used_files["include_once"][$filename])) {
$__used_files["include_once"][$filename] = true;
include($filename);
}
}

@include description 使用范围：use
指明包含的文件的信息。
举例：
/**
* 抽象绘图类的定义.
*
* @include Function: _require_
*/
require("abstract.php");

@link URL description 使用范围：class, function, var, module, define, use
定义在线连接，如上面3.4中讲到的，你可以使用@link添加适当的在线链接。
例如：@link http://www.phpDocumentor.de/ PhpDocumentor Home

@magic description
这个标记在phpDocumentor中没有说明，具体用法现在仍不清楚

@module label 使用范围：module
定义归属的模块信息，label是模块的名字，拥有相同的模块名字的函数在索引分类中将被组合在一起。如果你没有使用OOP的思想来编写PEAR代码，那么建议你使用这个标记把相关的函数归集到相应的模块下面，这样你的整体的框架不至于过于零散和混乱。

@modulegroup label 使用范围：module
定义归属的模块组 label是这个模块组的名字，如果你的应用程序的模块很多，你可以把不同的模块按照逻辑功能的不同，划分成相应的模块组，这样，你的应用框架可以有比较清晰的逻辑关系。这是对于没有使用OOP编程的来说的，如果使用OOP的思想，没有必要使用模块组的概念，因为直接使用"包-超类--基类--子类"的形式来体现你的框架结构要比使用"包-模块组-模块"的形式好的多。

@package label 使用范围：class, module
定义归属的包的信息,label 是这个包的名字。相同的包的名字的类在最终文档索引中将被分在一起。实际上，包还可以理解为不同的名字空间，虽然PHP没有名字空间的概念，但是你可以把相关的类、模块都归属于同一个包，这样，相当于组织了一个名字空间，当然，你的应用框架可能会有不同的包，可惜的是，这种情况下从语法上是得不到名字空间这种保证的，你只能通过人为地去避免不同的包的函数或者类重名。

@param[eter] (object objecttype|type) [$varname] [description] 使用范围：function
定义函数或者方法的参数信息。这是最常使用的文档标记了。

ojecttype 是对象的类名，type 指出这个参数的类型，它可以是下列类型：

string 该参数是一个字符型变量。
array 该参数是一个数组。
integer 该参数是一个数值型。
integer (octal) 该参数是一个数值型，并且是按照八进制方式存放。
integer (hexadecimal) 该参数是一个数值型，并且是按照十六进制方式存放。
boolean 该参数是一个布尔型。
mixed 该参数的类型是可变的，可以上面几种类型的组合。不过，在随后的说明中一般要说明可以接受的变量的类型。
$varname 是形参的名称
[description] 是对于参数的说明。
如果函数接受的是多个参数，那么要按照从左到右，依次用@param对齐列出，如下面所示：
*
* @param array $tags array of tags returned by getTags
* @param array $data array where the allowed tags and their values are copied to
* @param array $allowed array of allowed (recognized) tags

@return (object objecttype|type) [$varname] 使用范围：function
定义函数或者方法的返回信息。
返回信息的类型同@param一样，$varname是返回变量的名称，可有可无。不同的是@return只有一个，不会出现多个@return

@see (function()|$varname|((module|class):