[LNMP]php程序注释建议规范和工具

说明

本注释建议适用于php程序开发，包括基于Yii框架的php开发，不局限于本规范所列出的注释参数，但至少遵循phpDoc的标准进行注释。

类文件注释

适用于自定义的类文件或其他php文件的注释，放在文件的头部
<pre>
/**
* 描述你的类或文件的作用
*
* @package 所属的模块名或函数组名，例如：本类文件是Gather模块的其中一个数据处理类，那填上Gather
* @author 你的名字简称或账户名
* @copyright XXX Inc
* @version 本文件的版本号，例如：1.0
*/

class DataHandleForGather{
//code
}
</pre>

类：属性注释

适用于类属性或常量定义的注释
<pre>
/**
* 属性说明
*
* @var 属性的数据类型，例如：String,Array
*/
public $currentStringEncoding = "";
</pre>

类：方法注释

<pre>
/**
* 本方法的描述
* @param 参数类型参数名，例如：String $currentStringEncoding
* @return 返回值的类型，例如：boolean,string,array
*/
public function isUtf8String($currentStringEncoding){
//code
}
</pre>

类注释范例

DataHandleForGather.php
<pre>
/**
* 描述你的类或文件的作用
*
* @package 所属的模块名或函数组名，例如：本类文件是Gather模块的其中一个数据处理类，那填上Gather
* @author 你的名字简称或账户名
* @copyright Dayoo Rnd
* @version 本文件的版本号，例如：1.0
*/
class DataHandleForGather{
/**
* 属性说明
*
* @var 属性的数据类型，例如：String,Array
*/
public $currentStringEncoding;

/**
* 本方法的描述
* @param 参数类型参数名，例如：String $currentStringEncoding
* @return 返回值的类型，例如：boolean,string,array
*/
public function isUtf8String($currentStringEncoding){
//code
}
...
}
</pre>

phpDoc注释标准

phpDoc的官方标准

phpDoc

注释辅助工具：DocBlockr

适用于sublime：DocBlockr，可以提高注释的效率，并且格式统一。

整理于2014/11