注釋在寫代碼的過程中非常重要,好的注釋能讓你的代碼讀起來更輕松,在寫代碼的時候一定要注意注釋的規(guī)范。
php里面常見的幾種注釋方式:
1.文件頭的注釋,介紹文件名,功能以及作者版本號等信息
/**
*文件名簡單介紹
*
*文件功能。
* @author alvin 作者
* @version 1.0 版本號
*/
2.函數(shù)的注釋,函數(shù)作用,參數(shù)介紹及返回類型
/**
* 函數(shù)的含義說明
*
* @access public
* @param mixed $arg1 參數(shù)一的說明
* @param mixed $arg2 參數(shù)二的說明
* @param mixed $mixed 這是一個混合類型
* @return array 返回類型
*/
3.類的注釋,類名及介紹
/**
* 類的介紹
*
* 類的詳細介紹(可選。)。
* @author alvin 作者
* @version 1.0 版本號
*/
4.多行注釋
/* php注釋語法
這是多行注釋。*/
5.單行注釋
$n = 10; //數(shù)量n,這是單行注釋