PHP Document 代码注释规范

1. 什么是phpDocumentor ? <br>PHPDocumentor 是一个用PHP写的工具，对于有规范注释的php程序，它能够快速生成具有相互参照,索引等功能的API文档。老的版本是 phpdoc，从1.3.0开始，更名为phpDocumentor，新的版本加上了对php5语法的支持，同时，可以通过在客户端浏览器上操作生成文档，文档可以转换为PDF,HTML,CHM几种形式，非常的方便。 <br>PHPDocumentor工作时，会扫描指定目录下面的php源代码，扫描其中的关键字，截取需要分析的注释，然后分析注释中的专用的tag，生成 xml文件，接着根据已经分析完的类和模块的信息，建立相应的索引，生成xml文件，对于生成的xml文件，使用定制的模板输出为指定格式的文件。 <br>2. 安装phpDocumentor <br>和其他pear下的模块一样，phpDocumentor的安装也分为自动安装和手动安装两种方式，两种方式都非常方便： <br>a． 通过pear 自动安装 <br>在命令行下输入 <br>pear install PhpDocumentor <br>b． 手动安装 <br>在http://manual.phpdoc.org/下载最新版本的PhpDocumentor（现在是1.4.0），把内容解压即可。 <br>3．怎样使用PhpDocumentor生成文档 <br>命令行方式： <br>在phpDocumentor所在目录下，输入 <br>Php –h <br>会得到一个详细的参数表，其中几个重要的参数如下： <br>-f 要进行分析的文件名，多个文件用逗号隔开 <br>-d 要分析的目录，多个目录用逗号分割 <br>-t 生成的文档的存放路径 <br>-o 输出的文档格式，结构为输出格式：转换器名：模板目录。 <br>例如：phpdoc -o HTML:frames:earthli -f test.php -t docs <br>Web界面生成 <br>在新的phpdoc中，除了在命令行下生成文档外，还可以在客户端浏览器上操作生成文档，具体方法是先把PhpDocumentor的内容放在apache目录下使得通过浏览器可以访问到，访问后显示如下的界面： <br>点击files按钮，选择要处理的php文件或文件夹，还可以通过该指定该界面下的Files to ignore来忽略对某些文件的处理。 <br>然后点击output按钮来选择生成文档的存放路径和格式. <br>最后点击create，phpdocumentor就会自动开始生成文档了，最下方会显示生成的进度及状态，如果成功，会显示 <br>Total Documentation Time: 1 seconds <br>done <br>Operation Completed!! <br>然后，我们就可以通过查看生成的文档了，如果是pdf格式的，名字默认为documentation.pdf。 <br>4．给php代码添加规范的注释 <br>PHPDocument是从你的源代码的注释中生成文档，因此在给你的程序做注释的过程，也就是你编制文档的过程。 <br>从这一点上讲，PHPdoc促使你要养成良好的编程习惯，尽量使用规范，清晰文字为你的程序做注释，同时多多少少也避免了事后编制文档和文档的更新不同步的一些问题。 <br>在phpdocumentor中，注释分为文档性注释和非文档性注释。 <br>所谓文档性注释，是那些放在特定关键字前面的多行注释，特定关键字是指能够被phpdoc分析的关键字，例如class，var等，具体的可参加附录1. <br>那些没有在关键字前面或者不规范的注释就称作非文档性注释，这些注释将不会被phpdoc所分析，也不会出现在你产生的api文当中。 <br>3.2如何书写文档性注释: <br>所有的文档性注释都是由/**开始的一个多行注释，在phpDocumentor里称为DocBlock, DocBlock是指软件开发人员编写的关于某个关键字的帮助信息，使得其他人能够通过它知道这个关键字的具体用途，如何使用。 PhpDocumentor规定一个DocBlock包含如下信息： <br>1. 功能简述区 <br>2. 详细说明区 <br>3. 标记tag <br>文档性注释的第一行是功能描述区，正文一般是简明扼要地说明这个类，方法或者函数的功能，功能简述的正文在生成的文档中将显示在索引区。功能描述区的内容可以通过一个空行或者 . 来结束 <br>在功能描述区后是一个空行，接着是详细说明区,. 这部分主要是详细说明你的API的功能，用途，如果可能，也可以有用法举例等等。在这部分，你应该着重阐明你的API函数或者方法的通常的用途，用法，并且指明是否是跨平台的（如果涉及到），对于和平台相关的信息，你要和那些通用的信息区别对待，通常的做法是另起一行，然后写出在某个特定平台上的注意事项或者是特别的信息，这些信息应该足够，以便你的读者能够编写相应的测试信息，比如边界条件，参数范围，断点等等。 <br>之后同样是一个空白行，然后是文档的标记tag，指明一些技术上的信息，主要是最主要的是调用参数类型，返回值极其类型，继承关系，相关方法/函数等等。 <br>关于文档标记，详细的请参考第四节:文档标记。 <br>文档注释中还可以使用例如 这样的标签，详细介绍请参考附录二。 &lt;br&gt;下面是一个文档注释的例子 &lt;br&gt;/** &lt;br&gt;* 函数add,实现两个数的加法 &lt;br&gt;* &lt;br&gt;* 一个简单的加法计算，函数接受两个数a、b，返回他们的和c &lt;br&gt;* &lt;br&gt;* @param int 加数 &lt;br&gt;* @param int 被加数 &lt;br&gt;* @return integer &lt;br&gt;*/ &lt;br&gt;function Add($a, $b) { &lt;br&gt;return $a+$b; &lt;br&gt;} &lt;br&gt;生成文档如下： &lt;br&gt;Add &lt;br&gt;integer Add( int $a, int $b) &lt;br&gt;[line 45] &lt;br&gt;函数add,实现两个数的加法 &lt;br&gt;Constants 一个简单的加法计算，函数接受两个数a、b，返回他们的和c &lt;br&gt;Parameters &lt;br&gt;• int $a - 加数 &lt;br&gt;• int $b - 被加数 &lt;br&gt;5．文档标记： &lt;br&gt;文档标记的使用范围是指该标记可以用来修饰的关键字，或其他文档标记。 &lt;br&gt;所有的文档标记都是在每一行的 * 后面以@开头。如果在一段话的中间出来@的标记，这个标记将会被当做普通内容而被忽略掉。 &lt;br&gt;@access &lt;br&gt;使用范围：class,function,var,define,module &lt;br&gt;该标记用于指明关键字的存取权限：private、public或proteced &lt;br&gt;@author &lt;br&gt;指明作者 &lt;br&gt;@copyright &lt;br&gt;使用范围：class，function，var，define，module，use &lt;br&gt;指明版权信息 &lt;br&gt;@deprecated &lt;br&gt;使用范围：class，function，var，define，module，constent，global，include &lt;br&gt;指明不用或者废弃的关键字 &lt;br&gt;@example &lt;br&gt;该标记用于解析一段文件内容，并将他们高亮显示。Phpdoc会试图从该标记给的文件路径中读取文件内容 &lt;br&gt;@const &lt;br&gt;使用范围：define &lt;br&gt;用来指明php中define的常量 &lt;br&gt;@final &lt;br&gt;使用范围：class,function,var &lt;br&gt;指明关键字是一个最终的类、方法、属性，禁止派生、修改。 &lt;br&gt;@filesource &lt;br&gt;和example类似，只不过该标记将直接读取当前解析的php文件的内容并显示。 &lt;br&gt;@global &lt;br&gt;指明在此函数中引用的全局变量 &lt;br&gt;@ingore &lt;br&gt;用于在文档中忽略指定的关键字 &lt;br&gt;@license &lt;br&gt;相当于html标签中的<a>,首先是URL，接着是要显示的内容 &lt;br&gt;例如</a><a href="%E2%80%9Dhttp://www.baidu.com%E2%80%9D">百度</a> &lt;br&gt;可以写作 @license http://www.baidu.com 百度 &lt;br&gt;@link &lt;br&gt;类似于license &lt;br&gt;但还可以通过link指到文档中的任何一个关键字 &lt;br&gt;@name &lt;br&gt;为关键字指定一个别名。 &lt;br&gt;@package &lt;br&gt;使用范围：页面级别的-> define，function，include &lt;br&gt;类级别的->class，var，methods &lt;br&gt;用于逻辑上将一个或几个关键字分到一组。 &lt;br&gt;@abstrcut &lt;br&gt;说明当前类是一个抽象类 &lt;br&gt;@param &lt;br&gt;指明一个函数的参数 &lt;br&gt;@return &lt;br&gt;指明一个方法或函数的返回指 &lt;br&gt;@static &lt;br&gt;指明关建字是静态的。 &lt;br&gt;@var &lt;br&gt;指明变量类型 &lt;br&gt;@version &lt;br&gt;指明版本信息 &lt;br&gt;@todo &lt;br&gt;指明应该改进或没有实现的地方 &lt;br&gt;@throws &lt;br&gt;指明此函数可能抛出的错误异常,极其发生的情况 &lt;br&gt;上面提到过，普通的文档标记标记必须在每行的开头以@标记，除此之外，还有一种标记叫做inline tag,用{@}表示，具体包括以下几种： &lt;br&gt;{@link} &lt;br&gt;用法同@link &lt;br&gt;{@source} &lt;br&gt;显示一段函数或方法的内容 &lt;br&gt;6．一些注释规范 &lt;br&gt;a.注释必须是 &lt;br&gt;/** &lt;br&gt;* XXXXXXX &lt;br&gt;*/ &lt;br&gt;的形式 &lt;br&gt;b.对于引用了全局变量的函数，必须使用glboal标记。 &lt;br&gt;c.对于变量，必须用var标记其类型（int,string,bool...） &lt;br&gt;d.函数必须通过param和return标记指明其参数和返回值 &lt;br&gt;e.对于出现两次或两次以上的关键字，要通过ingore忽略掉多余的，只保留一个即可 &lt;br&gt;f.调用了其他函数或类的地方，要使用link或其他标记链接到相应的部分，便于文档的阅读。 &lt;br&gt;g.必要的地方使用非文档性注释，提高代码易读性。 &lt;br&gt;h.描述性内容尽量简明扼要，尽可能使用短语而非句子。 &lt;br&gt;i.全局变量，静态变量和常量必须用相应标记说明 &lt;br&gt;7. 总结 &lt;br&gt;phpDocumentor是一个非常强大的文档自动生成工具，利用它可以帮助我们编写规范的注释，生成易于理解，结构清晰的文档，对我们的代码升级，维护,移交等都有非常大的帮助。 &lt;br&gt;关于phpDocumentor更为详细的说明，可以到它的官方网站 &lt;br&gt;http://manual.phpdoc.org/查阅 &lt;br&gt;8．附录 &lt;br&gt;<strong>附录1:</strong> &lt;br&gt;能够被phpdoc识别的关键字： &lt;br&gt;Include &lt;br&gt;Require &lt;br&gt;include_once &lt;br&gt;require_once &lt;br&gt;define &lt;br&gt;function &lt;br&gt;global &lt;br&gt;class &lt;br&gt;<strong>附录2</strong> &lt;br&gt;文档中可以使用的标签 &lt;br&gt;<b> &lt;br&gt;<code> &lt;br&gt;<br> &lt;br&gt;<kdb> &lt;br&gt;<li> &lt;br&gt;<pre class="brush:php;toolbar:false"> &lt;br&gt;</pre> <ul> &lt;br&gt;<samp> &lt;br&gt;<var> &lt;br&gt;<strong>附录三：</strong> &lt;br&gt;一段含有规范注释的php代码 : &lt;br&gt;<p class="codetitle"><span style="CURSOR: pointer" onclick="doCopy('code53020')"><u>复制代码</u></span> 代码如下:</p> <p class="codebody" id="code53020"><br><?php <BR>/** &lt;br&gt;* Sample File 2, phpDocumentor Quickstart &lt;br&gt;* &lt;br&gt;* This file demonstrates the rich information that can be included in &lt;br&gt;* in-code documentation through DocBlocks and tags. &lt;br&gt;* @author Greg Beaver &lt;br&gt;* @version 1.0 &lt;br&gt;* @package sample &lt;br&gt;*/ &lt;br&gt;// sample file #1 &lt;br&gt;/** &lt;br&gt;* Dummy include value, to demonstrate the parsing power of phpDocumentor &lt;br&gt;*/ &lt;br&gt;include_once 'sample3.php'; &lt;br&gt;/** &lt;br&gt;* Special global variable declaration DocBlock &lt;br&gt;* @global integer $GLOBALS['_myvar'] &lt;br&gt;* @name $_myvar &lt;br&gt;*/ &lt;br&gt;$GLOBALS['_myvar'] = 6; &lt;br&gt;/** &lt;br&gt;* Constants &lt;br&gt;*/ &lt;br&gt;/** &lt;br&gt;* first constant &lt;br&gt;*/ &lt;br&gt;define('testing', 6); &lt;br&gt;/** &lt;br&gt;* second constant &lt;br&gt;*/ &lt;br&gt;define('anotherconstant', strlen('hello')); &lt;br&gt;/** &lt;br&gt;* A sample function docblock &lt;br&gt;* @global string document the fact that this function uses $_myvar &lt;br&gt;* @staticvar integer $staticvar this is actually what is returned &lt;br&gt;* @param string $param1 name to declare &lt;br&gt;* @param string $param2 value of the name &lt;br&gt;* @return integer &lt;br&gt;*/ &lt;br&gt;function firstFunc($param1, $param2 = 'optional') { &lt;br&gt;static $staticvar = 7; &lt;br&gt;global $_myvar; &lt;br&gt;return $staticvar; &lt;br&gt;} &lt;br&gt;/** &lt;br&gt;* The first example class, this is in the same package as the &lt;br&gt;* procedural stuff in the start of the file &lt;br&gt;* @package sample &lt;br&gt;* @subpackage classes &lt;br&gt;*/ &lt;br&gt;class myclass { &lt;br&gt;/** &lt;br&gt;* A sample private variable, this can be hidden with the --parseprivate &lt;br&gt;* option &lt;br&gt;* @accessprivate &lt;br&gt;* @var integer|string &lt;br&gt;*/ &lt;br&gt;var $firstvar = 6; &lt;br&gt;/** &lt;br&gt;* @link http://www.example.com Example link &lt;br&gt;* @see myclass() &lt;br&gt;* @uses testing, anotherconstant &lt;br&gt;* @var array &lt;br&gt;*/ &lt;br&gt;var $secondvar = &lt;br&gt;array( &lt;br&gt;'stuff' => &lt;br&gt;array( &lt;br&gt;6, &lt;br&gt;17, &lt;br&gt;'armadillo' &lt;br&gt;), &lt;br&gt;testing => anotherconstant &lt;br&gt;); &lt;br&gt;/** &lt;br&gt;* Constructor sets up {@link $firstvar} &lt;br&gt;*/ &lt;br&gt;function myclass() { &lt;br&gt;$this->firstvar = 7; &lt;br&gt;} &lt;br&gt;/** &lt;br&gt;* Return a thingie based on $paramie &lt;br&gt;* @param boolean $paramie &lt;br&gt;* @return integer|babyclass &lt;br&gt;*/ &lt;br&gt;function parentfunc($paramie) { &lt;br&gt;if ($paramie) { &lt;br&gt;return 6; &lt;br&gt;} else { &lt;br&gt;return new babyclass; &lt;br&gt;} &lt;br&gt;} &lt;br&gt;} &lt;br&gt;/** &lt;br&gt;* @package sample1 &lt;br&gt;*/ &lt;br&gt;class babyclass extends myclass { &lt;br&gt;/** &lt;br&gt;* The answer to Life, the Universe and Everything &lt;br&gt;* @var integer &lt;br&gt;*/ &lt;br&gt;var $secondvar = 42; &lt;br&gt;/** &lt;br&gt;* Configuration values &lt;br&gt;* @var array &lt;br&gt;*/ &lt;br&gt;var $thirdvar; &lt;br&gt;/** &lt;br&gt;* Calls parent constructor, then increments {@link $firstvar} &lt;br&gt;*/ &lt;br&gt;function babyclass() { &lt;br&gt;parent::myclass(); &lt;br&gt;$this->firstvar++; &lt;br&gt;} &lt;br&gt;/** &lt;br&gt;* This always returns a myclass &lt;br&gt;* @param ignored $paramie &lt;br&gt;* @return myclass &lt;br&gt;*/ &lt;br&gt;function parentfunc($paramie) { &lt;br&gt;return new myclass; &lt;br&gt;} &lt;br&gt;} &lt;br&gt;?> &lt;br&gt;</p> </var></samp> </ul> </li></kdb>