PHP 編碼規范(6)

4.2 單行註釋

短註釋可以顯示在一行內,並與其後的代碼具有一樣的縮進層級。如果一個註釋不能在一行內寫完,就該采用塊註釋。單行註釋之前應該有一個空行。以下是一個代碼中單行註釋的例子:


if (condition) {

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

極短的註釋可以與它們所要描述的代碼位於同一行,但是應該有足夠的空白來分開代碼和註釋。若有多個短註釋出現於大段代碼中,它們應該具有相同的縮進。

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


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

發佈留言