說明
本注釋建議適用于php程序開發(fā)得湘，包括基于Yii框架的php開發(fā)杖玲，不局限于本規(guī)范所列出的注釋參數(shù)，但至少遵循phpDoc的標(biāo)準(zhǔn)進(jìn)行注釋淘正。
類文件注釋
適用于自定義的類文件或其他php文件的注釋摆马，放在文件的頭部
/**
* 描述你的類或文件的作用
*
* @package 所屬的模塊名或函數(shù)組名，例如：本類文件是Gather模塊的其中一個(gè)數(shù)據(jù)處理類鸿吆，那填上Gather
* @author 你的名字簡(jiǎn)稱或賬戶名
* @copyright XXX Inc
* @version 本文件的版本號(hào)囤采，例如：1.0
*/
class DataHandleForGather{
//code
}
類：屬性注釋
適用于類屬性或常量定義的注釋
/**
* 屬性說明
*
* @var 屬性的數(shù)據(jù)類型，例如：String,Array
*/
public $currentStringEncoding = "";
類：方法注釋
/**
* 本方法的描述
* @param 參數(shù)類型 參數(shù)名惩淳，例如：String $currentStringEncoding
* @return 返回值的類型蕉毯，例如：boolean,string,array
*/
public function isUtf8String($currentStringEncoding){
//code
}
類注釋范例
DataHandleForGather.php
/**
* 描述你的類或文件的作用
*
* @package 所屬的模塊名或函數(shù)組名，例如：本類文件是Gather模塊的其中一個(gè)數(shù)據(jù)處理類思犁，那填上Gather
* @author 你的名字簡(jiǎn)稱或賬戶名
* @copyright Dayoo Rnd
* @version 本文件的版本號(hào)代虾，例如：1.0
*/
class DataHandleForGather{
/**
* 屬性說明
*
* @var 屬性的數(shù)據(jù)類型，例如：String,Array
*/
public $currentStringEncoding;
/**
* 本方法的描述
* @param 參數(shù)類型 參數(shù)名激蹲，例如：String $currentStringEncoding
* @return 返回值的類型棉磨，例如：boolean,string,array
*/
public function isUtf8String($currentStringEncoding){
//code
}
...
}
