php注釋規範

標籤：規範   http   image   blog   mon   copy   common   tool   代碼   

注釋在寫代碼的過程中非常重要，好的注釋能讓你的代碼讀起來更輕鬆，在寫代碼的時候一定要注意注釋的規範。（李昌輝）

php裡面常見的幾種注釋方式：

1.檔案頭的注釋，介紹檔案名稱，功能以及作者版本號碼等資訊

/** *檔案名稱簡單介紹* *檔案功能。 * @author     * @version     1.0 版本號碼*/ 

2.函數的注釋，函數作用，參數介紹及傳回型別

/**  * 函數的含義說明 * * @access public * @param mixed $arg1 參數一的說明 * @param mixed $arg2 參數二的說明 * @param mixed $mixed 這是一個混合類型 * @return array 傳回型別*/  

3.類的注釋，類名及介紹

/** * 類的介紹 * * 類的詳細介紹（可選。）。 * @author     * @version     1.0 版本號碼*/ 

4.多行注釋

/* php注釋文法   這是多行注釋。*/ 

5.單行注釋

$n = 10; //數量n，這是單行注釋

php注釋規範