欧美日韩精品在线,国内精品久久久久久久久,一级毛片恃级毛片直播,清纯唯美亚洲综合欧美色

淺談PHP 編碼規(guī)范-注釋_PHP教程

編輯Tag賺U幣
教程Tag:暫無(wú)Tag,歡迎添加,賺取U幣!

推薦:怎樣用PHP編程語(yǔ)言開發(fā)動(dòng)態(tài)WAP頁(yè)面
WAP(無(wú)線通訊協(xié)議)是在數(shù)字移動(dòng)電話、個(gè)人手持設(shè)備(PDA等)及計(jì)算機(jī)之間進(jìn)行通訊的開放性全球標(biāo)準(zhǔn)協(xié)議。隨著無(wú)線通訊的不斷發(fā)展,靜態(tài)的WAP頁(yè)面在很多方面已經(jīng)不能滿足用戶個(gè)性化的要求,因此開發(fā)者可以在WAP服務(wù)器端使用諸如PHP等語(yǔ)言產(chǎn)生動(dòng)態(tài)的WML頁(yè)面,來(lái)

4.1 塊注釋

塊注釋通常用于提供對(duì)文件,方法,數(shù)據(jù)結(jié)構(gòu)和算法的描述。塊注釋被置于每個(gè)文件的開始處以及每個(gè)方法之前。它們也可以被用于其他地方,比如方法內(nèi)部。在功能和方法內(nèi)部的塊注釋應(yīng)該和它們所描述的代碼具有一樣的縮進(jìn)格式。

塊注釋之首應(yīng)該有一個(gè)空行,用于把塊注釋和代碼分割開來(lái),比如:


/*
 * 這里是塊注釋
*/


塊注釋可以以/*-開頭,這樣indent(1)就可以將之識(shí)別為一個(gè)代碼塊的開始,而不會(huì)重排它。


/*-
 * 如果想被忽略,可是使用特別格式的塊注釋
 *
 * one
 *   two
 *     three
 */


注意:如果你不使用indent(1),就不必在代碼中使用/*-,或?yàn)樗丝赡軐?duì)你的代碼運(yùn)行indent(1)作讓步。
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); /* 其余的條件 */
}

4.4 行末注釋

注釋界定符"//",可以注釋掉整行或者一行中的一部分。它一般不用于連續(xù)多行的注釋文本;然而,它可以用來(lái)注釋掉連續(xù)多行的代碼段。以下是所有三種風(fēng)格的例子:


if ($foo > 1) {

  // 第二種用法.
  ...
}
else {
  return false; // 說(shuō)明返回值的原因
}

//if ($bar > 1) {
//
//  // 第三種用法
//  ...
//}
//else {
  // return false;
//}
4.5 文檔注釋

文檔注釋描述php的類、構(gòu)造器,方法,以及字段(field)。每個(gè)文檔注釋都會(huì)被置于注釋定界符/**...*/之中,一個(gè)注釋對(duì)應(yīng)一個(gè)類或成員。該注釋應(yīng)位于聲明之前:


/**
 * 說(shuō)明這個(gè)類的一些 ...
*/
class Example { ...


注意頂層(top-level)的類是不縮進(jìn)的,而其成員是縮進(jìn)的。描述類的文檔注釋的第一行(/**)不需縮進(jìn);隨后的文檔注釋每行都縮進(jìn)1格(使星號(hào)縱向?qū)R)。成員,包括構(gòu)造函數(shù)在內(nèi),其文檔注釋的第一行縮進(jìn)4格,隨后每行都縮進(jìn)5格。

若你想給出有關(guān)類、變量或方法的信息,而這些信息又不適合寫在文檔中,則可使用實(shí)現(xiàn)塊注釋(見5.1.1)或緊跟在聲明后面的單行注釋(見5.1.2)。例如,有關(guān)一個(gè)類實(shí)現(xiàn)的細(xì)節(jié),應(yīng)放入緊跟在類聲明后面的實(shí)現(xiàn)塊注釋中,而不是放在文檔注釋中。

文檔注釋不能放在一個(gè)方法或構(gòu)造器的定義塊中,因?yàn)槌绦驎?huì)將位于文檔注釋之后的第一個(gè)聲明與其相關(guān)聯(lián)。

分享:淺談PHP5 OOP編程之代理與定制異常(2)
三、 拋出異常 你可能已經(jīng)從上面的代碼中注意到,你捕獲的是一個(gè)稱為QueryException(我們將在后面實(shí)現(xiàn)這個(gè)對(duì)象)的異常。一個(gè)異常類似于一個(gè)錯(cuò)誤,然而卻更具有一般性。描述一個(gè)異常的最好的方法是使用emergency。盡管一個(gè)emergency可以不會(huì)是致命的,但是還

來(lái)源:模板無(wú)憂//所屬分類:PHP教程/更新時(shí)間:2009-05-16
相關(guān)PHP教程