PHP代码注释规范

一、PHP注释的方式

• // 这是单行注释
• ‘ # ’ 这也是单行注释
• /** 多行注释块 */

PHP 代码中的注释不会被作为程序来读取和执行。它唯一的作用是供代码编辑者阅读。

二、PHP程序标准注释的规范准则

在项目代码内,文档在软件设计中起着至关重要的作用。在团队共同开发过程中， 注释对于帮助开发人员理解系统和有效地工作是必不可少的，但是注释的作用远远不止于此。文档在抽象中也扮演着重要的角色;没有注释，就无法隐藏复杂性。最后，编写注释的过程如果处理正确，实际上将改进系统的设计。

类、文件注释

1. 文件注释使用 PEAR 推荐的多行注释方式，不能使用 // 来注释
2. 所有类必须添加说明信息，推荐项目包括：创建者信息、创建时间、更新时间、更新说明、版本号、程序（文件）描述、项目名称等，注释信息可根据需要添加或减少。

实例说明

/** 
*此文件程序用来做什么的（详细说明，可选。eg:人资模块 —— 部门管理：控制器）。
* Class 类名称（DeptController）
* @package 	   文件路径（XXX/XXX/Controller）
* @author      XXX<XXX@163.com> 
* @version     $Id$ 
* @since        1.0 
*/
class DeptController {

}

方法注释

1. 抽象方法说明、方法函数外部说明推荐使用 PEAR 推荐的多行注释方式，不推荐不能使用 // 来注释
2. 方法函数内部代码注释时单行使用 // 注释，多行推荐使用/** ... */ 来注释
3. 必须说明返回值、参数和实现功能

实例说明

/** 
*  
* 函数方法说明 (XXX-部门管理-XXX模块-创建)
* 函数方法名称 (actionDeptCreate)
* @access public 
* @param mixed $arg1 参数一的说明 
* @param mixed $arg2 参数二的说明 
* @return array 
*/
public function actionDeptCreate(mixed $arg1, mixed $arg2 = false): array
    {
    	//代码编写
        rerturn [];
    }

代码注释

1. 使用 // 来单行注释代码片段、业务逻辑等
2. 使用 /** ... */ 来多行注释代码片段、业务逻辑等

特殊注释

// TODO ：标记待办的业务逻辑
// FIXME ：此处存在错误，需要检查修补

实例说明

if (true) {
	// FIXME 拼接查询条件出错、需稍后处理
    // TODO 需求待协商，稍后处理
}

其他说明

• 注释中建议使用中文，不建议使用英文
• 注释要与注释对象对齐
• 后期修改代码时要同时修改注释
• 注释掉的代码要尽量使用注释说明
• 注释恰到好处，即可语义清晰之处尽量不要使用注释，以免本末倒置，增加后期代码维护的工作量

三、PHP常用注解方法

/**
* @access        该标记用于指明关键字的存取权限：private、public或proteced使用范围：class,function,var,define,module
* @author        指明作者
* @copyright     指明版权信息
* @const         使用范围：define 用来指明php中define的常量
* @final         使用范围：class,function,var 指明关键字是一个最终的类、方法、属性，禁止派生、修改。
* @global        指明在此函数中引用的全局变量
* @name          为关键字指定一个别名。
* @package       用于逻辑上将一个或几个关键字分到一组。
* @abstrcut      说明当前类是一个抽象类
* @param         指明一个函数的参数
* @return        指明一个方法或函数的返回值
* @static        指明关建字是静态的。
* @var           指明变量类型
* @version       指明版本信息
* @todo          指明应该改进或没有实现的地方
* @link          可以通过link指到文档中的任何一个关键字
* @ingore        用于在文档中忽略指定的关键字
*/