注釋在寫代碼的過(guò)程中非常重要筹淫,好的注釋能讓你的代碼讀起來(lái)更輕松减俏,在寫代碼的時(shí)候一定要注意注釋的規(guī)范。
1 文件頭的注釋串塑,介紹文件名,功能以及作者版本號(hào)等信息
/**
*文件名簡(jiǎn)單介紹
*
*文件功能北苟。
* @author alvin 作者
* @version 1.0 版本號(hào)
*/
2 函數(shù)的注釋桩匪,函數(shù)作用,參數(shù)介紹及返回類型
/**
* 函數(shù)的含義說(shuō)明
*
* @access public
* @param int $arg1 參數(shù)一的說(shuō)明
* @param string $arg2 參數(shù)二的說(shuō)明
* @param mixed $mixed 這是一個(gè)混合類型
* @return array 返回類型
*/
3 類的注釋友鼻,類名及介紹
/**
* 類的介紹
*
* 類的詳細(xì)介紹(可選傻昙。)闺骚。
* @author alvin 作者
* @version 1.0 版本號(hào)
*/
4 多行注釋
/**
* 多行注釋
*
*/
5 單行注釋
$name = 'jiangshui'; //單行注釋