php註釋規範

 

 

註釋在寫代碼的過程當中很是重要，好的註釋能讓你的代碼讀起來更輕鬆，在寫代碼的時候必定要注意註釋的規範。（轉自李老師）

php裏面常見的幾種註釋方式：

1.文件頭的註釋，介紹文件名，功能以及做者版本號等信息

/** 
*文件名簡單介紹
* 
*文件功能。 
* @author      alvin 做者
* @version     1.0 版本號
*/ 

2.函數的註釋，函數做用，參數介紹及返回類型

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

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

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

4.多行註釋

/* php註釋語法
   這是多行註釋。*/ 

5.單行註釋

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