1.phpDocumentor给php代码添加规范的源码注释

phpDocumentor给php代码添加规范的注释

       PHPDocumentor是用于从源代码注释生成文档的工具，因此，源码在进行代码注释时，源码实际上就是源码在编制文档。这促使开发者养成良好的源码编程习惯，力求使用规范、源码数据库同步源码清晰的源码文本描述程序。PHPDocumentor的源码使用，能够避免文档编制与更新不同步的源码问题，提高工作效率。源码

       在PHPDocumentor中，源码注释分为文档性注释和非文档性注释。源码文档性注释指的源码是特定关键字前的多行注释，如`class`、源码`var`等，源码具体规则参阅附录1。非文档性注释则不被视为有效注释，发卡网站源码怎么用不会参与生成API文档。正确书写文档性注释极为关键，它们以`/**`开始，结束于`*/`。此多行注释称为DocBlock，包含功能简述、详细说明、标记等信息。源码转换为文字格式

       功能简述区位于第一行，应简明扼要描述类、方法或函数的功能。此区内容在生成文档时将显示在索引区，可通过空行或`.`结束。详细说明区紧随功能简述后，详细描述API的功能、用途及使用方法，牛象指标预警源码包括示例。应着重描述API的通常用途、使用方式，并注明是否跨平台。对于与平台相关的信息，应区别对待，另起一行列出特定平台的注意事项或特别信息，帮助读者编写测试信息，crc循环冗余校验源码如边界条件、参数范围、断点等。

       标记（Tag）用于提供技术信息，特别是调用参数类型、返回值类型、继承关系及相关方法/函数等信息。关于标记的详细规则，请参考第四节：文档标记。文档注释中还可以使用``、``等标签，具体规则请查阅附录二。

       以一个简单的`Add`函数为例：`/

**

       * 函数add,实现两个数的加法

       *

       * 一个简单的加法计算，函数接受两个数a、b，返回他们的和c

       *

       * @param int 加数

       * @param int 被加数

       * @return integer

       */`

       函数定义如下：

       php

       function Add($a, $b)

       {

       return $a+$b;

       }

       生成的文档包括函数名、参数类型及描述等信息，如：

       函数add,实现两个数的加法

       integer Add( int $a, int $b)

       参数说明：

       int $a - 加数

       int $b - 被加数

       通过正确使用PHPDocumentor，开发者不仅能提高代码可读性，还能生成详尽的API文档，方便团队成员理解和使用代码。

扩展资料

       PHPDocumentor是一个用PHP写的工具，对于有规范注释的php程序，它能够快速生成具有相互参照，索引等功能的API文档。老的版本是phpdoc，从1.3.0开始，更名为phpDocumentor，新的版本加上了对php5语法的支持，同时，可以通过在客户端浏览器上操作生成文档，文档可以转换为PDF,HTML,CHM几种形式，非常的方便。