PHP 編碼規(guī)范(6)
發(fā)表時(shí)間:2024-02-05 來(lái)源:明輝站整理相關(guān)軟件相關(guān)文章人氣:
[摘要]4.2 單行注釋短注釋可以顯示在一行內(nèi),并與其后的代碼具有一樣的縮進(jìn)層級(jí)。如果一個(gè)注釋不能在一行內(nèi)寫完,就該采用塊注釋。單行注釋之前應(yīng)該有一個(gè)空行。以下是一個(gè)代碼中單行注釋的例子:if (condition) { /* 以下代碼運(yùn)行的條件 */ ...}4.3 尾端注釋極短的注釋可以與它們所要...
4.2 單行注釋短注釋可以顯示在一行內(nèi),并與其后的代碼具有一樣的縮進(jìn)層級(jí)。如果一個(gè)注釋不能在一行內(nèi)寫完,就該采用塊注釋。單行注釋之前應(yīng)該有一個(gè)空行。以下是一個(gè)代碼中單行注釋的例子:
if (condition) {
/* 以下代碼運(yùn)行的條件 */
...
}
4.3 尾端注釋
極短的注釋可以與它們所要描述的代碼位于同一行,但是應(yīng)該有足夠的空白來(lái)分開代碼和注釋。若有多個(gè)短注釋出現(xiàn)于大段代碼中,它們應(yīng)該具有相同的縮進(jìn)。
以下是一個(gè)代碼中尾端注釋的例子:
if ($a == 2) {
return TRUE; /* 對(duì)單一條件的說(shuō)明 */
} else {
return isPrime($a); /* 其余的條件 */
}