3. phpdoc基础
phpdoc是从你的源代码的注释中生成文档，因此在给你的程序做注释的过程，也就是你编制文档的过程。

从这一点上讲，phpdoc促使你要养成良好的编程习惯，尽量使用规范，清晰文字为你的程序做注释，同时多多少少也避免了事后编制文档和文档的更新不同步的一些问题。

编制符合phpdoc规范的注释是非常重要的，掌握了这一点，基本上就可以利用phpdoc为你工作了。

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

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


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



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

phpdocobject

common base class of all phpdoc classes


<b>private class phpdocobject </b>

common base class of all phpdoc classes
as a kind of common base class phpdocobject holdsconfiguration values (e.g. error
handling) and debuggingmethods (e.g. introspection()). it does not have a
constructor,so you can always inheritig phpdoc classes from thisclass without any trouble.

authors ulf wendel <ulf.wendel@phpdoc.de>
version $id: phpdocobject.php,v 1.3 2001/02/18 15:29:29 uw exp $

上一页  [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]  ... 下一页  >> 

在google里搜索更多使用PHPDoc轻松建立你的PEAR文档

	Web www.51ec.org

上一篇信息学院： 搜索引擎技术核心揭密(PHP)

下一篇信息学院： 比较PHPLIB Template和FastTemplate…