明輝手游網(wǎng)中心:是一個免費提供流行視頻軟件教程、在線學(xué)習(xí)分享的學(xué)習(xí)平臺!

PHP 編碼規(guī)范(6)

[摘要]4.2 單行注釋短注釋可以顯示在一行內(nèi),并與其后的代碼具有一樣的縮進層級。如果一個注釋不能在一行內(nèi)寫完,就該采用塊注釋。單行注釋之前應(yīng)該有一個空行。以下是一個代碼中單行注釋的例子:if (condition) {  /* 以下代碼運行的條件 */  ...}4.3 尾端注釋極短的注釋可以與它們所要...
4.2 單行注釋

短注釋可以顯示在一行內(nèi),并與其后的代碼具有一樣的縮進層級。如果一個注釋不能在一行內(nèi)寫完,就該采用塊注釋。單行注釋之前應(yīng)該有一個空行。以下是一個代碼中單行注釋的例子:


if (condition) {

  /* 以下代碼運行的條件 */
  ...
}
4.3 尾端注釋

極短的注釋可以與它們所要描述的代碼位于同一行,但是應(yīng)該有足夠的空白來分開代碼和注釋。若有多個短注釋出現(xiàn)于大段代碼中,它們應(yīng)該具有相同的縮進。

以下是一個代碼中尾端注釋的例子:


if ($a == 2) {
  return TRUE; /* 對單一條件的說明 */
} else {
  return isPrime($a); /* 其余的條件 */
}





相關(guān)文章