php代碼注釋規(guī)范

注釋在寫代碼的過程中非常重要,好的注釋能讓你的代碼讀起來更輕松,在寫代碼的時候一定要注意注釋的規(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,這是單行注釋
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

相關(guān)閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 136,715評論 19 139
  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 179,366評論 25 708
  • 01 昨天一個朋友在微信上找我,說她有一個同事A被迫主動離職。離職的時候領導對A說,“你比較優(yōu)秀,所以不會留下來。...
    喻立明閱讀 1,185評論 8 8
  • 人不僅應該嚴肅地生活,還該簡單、純粹、審美地生活。但是這樣來看要求太高,所以就不管不顧地抽身生活。
    M_152閱讀 135評論 0 0

友情鏈接更多精彩內(nèi)容