PHP教程：PHP編碼書(shū)寫(xiě)規(guī)范(2)_PHP教程

推薦：PHP中addcslashes函數(shù)與stripcslashes的用法
今天在寫(xiě)一個(gè)網(wǎng)站的英文版時(shí)，寫(xiě)完后填加英文資料，我隨便填寫(xiě)時(shí)一點(diǎn)問(wèn)題沒(méi)有，但每當(dāng)填加指定的內(nèi)容時(shí)卻填加不上，也不報(bào)錯(cuò)，我查看了數(shù)據(jù)庫(kù)，發(fā)現(xiàn)這個(gè)字段用的是“TEXT”數(shù)據(jù)數(shù)型，

4 注釋

4.1 塊注釋

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

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

/* 　* 這里是塊注釋 */

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

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

注意：如果你不使用indent(1)，就不必在代碼中使用/*-，或?yàn)樗�人可能�?duì)你的代碼運(yùn)行indent(1)作讓步。

4.2 單行注釋

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

if (condition) { 　　/* 以下代碼運(yùn)行的條件 */ 　　... }

4.3 尾端注釋

極短的注釋可以與它們所要描述的代碼位于同一行，但是應(yīng)該有足夠的空白來(lái)分開(kā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的類(lèi)、構(gòu)造器，方法，以及字段(field)。每個(gè)文檔注釋都會(huì)被置于注釋定界符/**...*/之中，一個(gè)注釋對(duì)應(yīng)一個(gè)類(lèi)或成員。該注釋?xiě)?yīng)位于聲明之前：

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

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

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

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

分享：PHP.MVC的模板標(biāo)簽系統(tǒng)
PHP.MVC的模板標(biāo)簽系統(tǒng)(PhpMVC_Tags)現(xiàn)在提供了3種類(lèi)型的標(biāo)簽:包含指令,聲明和表達(dá)式. 包含指令能讓我們將內(nèi)容分隔為許多模塊,比如:頁(yè)眉,頁(yè)腳或者內(nèi)容.包含的頁(yè)面可以是HTML,或者其他標(biāo)簽?zāi)０屙?yè)