淺談PHP 編碼規(guī)范-注釋_PHP教程
推薦:怎樣用PHP編程語言開發(fā)動態(tài)WAP頁面WAP(無線通訊協(xié)議)是在數(shù)字移動電話、個人手持設(shè)備(PDA等)及計算機之間進行通訊的開放性全球標準協(xié)議。隨著無線通訊的不斷發(fā)展,靜態(tài)的WAP頁面在很多方面已經(jīng)不能滿足用戶個性化的要求,因此開發(fā)者可以在WAP服務(wù)器端使用諸如PHP等語言產(chǎn)生動態(tài)的WML頁面,來
4.1 塊注釋
塊注釋通常用于提供對文件,方法,數(shù)據(jù)結(jié)構(gòu)和算法的描述。塊注釋被置于每個文件的開始處以及每個方法之前。它們也可以被用于其他地方,比如方法內(nèi)部。在功能和方法內(nèi)部的塊注釋應(yīng)該和它們所描述的代碼具有一樣的縮進格式。
塊注釋之首應(yīng)該有一個空行,用于把塊注釋和代碼分割開來,比如:
/*
* 這里是塊注釋
*/
塊注釋可以以/*-開頭,這樣indent(1)就可以將之識別為一個代碼塊的開始,而不會重排它。
/*-
* 如果想被忽略,可是使用特別格式的塊注釋
*
* one
* two
* three
*/
注意:如果你不使用indent(1),就不必在代碼中使用/*-,或為他人可能對你的代碼運行indent(1)作讓步。
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); /* 其余的條件 */
}
4.4 行末注釋
注釋界定符"//",可以注釋掉整行或者一行中的一部分。它一般不用于連續(xù)多行的注釋文本;然而,它可以用來注釋掉連續(xù)多行的代碼段。以下是所有三種風格的例子:
if ($foo > 1) {
// 第二種用法.
...
}
else {
return false; // 說明返回值的原因
}
//if ($bar > 1) {
//
// // 第三種用法
// ...
//}
//else {
// return false;
//}
4.5 文檔注釋
文檔注釋描述php的類、構(gòu)造器,方法,以及字段(field)。每個文檔注釋都會被置于注釋定界符/**...*/之中,一個注釋對應(yīng)一個類或成員。該注釋應(yīng)位于聲明之前:
/**
* 說明這個類的一些 ...
*/
class Example { ...
注意頂層(top-level)的類是不縮進的,而其成員是縮進的。描述類的文檔注釋的第一行(/**)不需縮進;隨后的文檔注釋每行都縮進1格(使星號縱向?qū)R)。成員,包括構(gòu)造函數(shù)在內(nèi),其文檔注釋的第一行縮進4格,隨后每行都縮進5格。
若你想給出有關(guān)類、變量或方法的信息,而這些信息又不適合寫在文檔中,則可使用實現(xiàn)塊注釋(見5.1.1)或緊跟在聲明后面的單行注釋(見5.1.2)。例如,有關(guān)一個類實現(xiàn)的細節(jié),應(yīng)放入緊跟在類聲明后面的實現(xiàn)塊注釋中,而不是放在文檔注釋中。
文檔注釋不能放在一個方法或構(gòu)造器的定義塊中,因為程序會將位于文檔注釋之后的第一個聲明與其相關(guān)聯(lián)。
分享:淺談PHP5 OOP編程之代理與定制異常(2)三、 拋出異常 你可能已經(jīng)從上面的代碼中注意到,你捕獲的是一個稱為QueryException(我們將在后面實現(xiàn)這個對象)的異常。一個異常類似于一個錯誤,然而卻更具有一般性。描述一個異常的最好的方法是使用emergency。盡管一個emergency可以不會是致命的,但是還
- 相關(guān)鏈接:
- 教程說明:
PHP教程-淺談PHP 編碼規(guī)范-注釋
。