PHP註釋規範

必須註釋的地方：PHP文件頭和函數頭

一、PHP文件頭註釋規範：

1    /**
2      * [description]             　　　　　　  PHP文件描述
3      * @author [author] <[email]>   　　　　　 做者信息，[做者名稱]<[郵箱地址]>
4      * @version [version]                　　 當前版本號[版本號]
5      * @since [version]            　　　　　　從項目哪一個版本加入此文件，[版本]
6      */

二、PHP方法（函數）註釋規範：

1     /**
2      * [function description]               　　　　方法（函數）描述
3      * @param  [type] $param1   [description]      方法（函數）傳入的參數1， @param [參數類型] $參數名 [描述]
4      * @param  [type] $param2 [description]　　　　 方法（函數）傳入的參數2， @param [參數類型] $參數名 [描述]
5      * @return [type]       [description]          方法（函數）的返回值，@return [返回值類型] [返回值描述]
6      */