PHP教程:PHP編碼書寫規(guī)范(2)_PHP教程
推薦:PHP中addcslashes函數(shù)與stripcslashes的用法今天在寫一個網(wǎng)站的英文版時,寫完后填加英文資料,我隨便填寫時一點(diǎn)問題沒有,但每當(dāng)填加指定的內(nèi)容時卻填加不上,也不報錯,我查看了數(shù)據(jù)庫,發(fā)現(xiàn)這個字段用的是“TEXT”數(shù)據(jù)數(shù)型,
4 注釋
4.1 塊注釋
塊注釋通常用于提供對文件,方法,數(shù)據(jù)結(jié)構(gòu)和算法的描述。塊注釋被置于每個文件的開始處以及每個方法之前。它們也可以被用于其他地方,比如方法內(nèi)部。在功能和方法內(nèi)部的塊注釋應(yīng)該和它們所描述的代碼具有一樣的縮進(jìn)格式。
塊注釋之首應(yīng)該有一個空行,用于把塊注釋和代碼分割開來,比如:
/* * 這里是塊注釋 */ |
塊注釋可以以/*-開頭,這樣indent(1)就可以將之識別為一個代碼塊的開始,而不會重排它。
/*- * 如果想被忽略,可是使用特別格式的塊注釋 * * one * two * three */ |
注意:如果你不使用indent(1),就不必在代碼中使用/*-,或為他人可能對你的代碼運(yùn)行indent(1)作讓步。
4.2 單行注釋
短注釋可以顯示在一行內(nèi),并與其后的代碼具有一樣的縮進(jìn)層級。如果一個注釋不能在一行內(nèi)寫完,就該采用塊注釋。單行注釋之前應(yīng)該有一個空行。以下是一個代碼中單行注釋的例子:
if (condition) { /* 以下代碼運(yùn)行的條件 */ |
4.3 尾端注釋
極短的注釋可以與它們所要描述的代碼位于同一行,但是應(yīng)該有足夠的空白來分開代碼和注釋。若有多個短注釋出現(xiàn)于大段代碼中,它們應(yīng)該具有相同的縮進(jìn)。
以下是一個代碼中尾端注釋的例子:
if ($a == 2) { return TRUE; /* 對單一條件的說明 */ } else { return isPrime($a); /* 其余的條件 */ } |
4.4 行末注釋
注釋界定符"//",可以注釋掉整行或者一行中的一部分。它一般不用于連續(xù)多行的注釋文本;然而,它可以用來注釋掉連續(xù)多行的代碼段。以下是所有三種風(fēng)格的例子:
if ($foo > 1) { |
4.5 文檔注釋
文檔注釋描述php的類、構(gòu)造器,方法,以及字段(field)。每個文檔注釋都會被置于注釋定界符/**...*/之中,一個注釋對應(yīng)一個類或成員。該注釋應(yīng)位于聲明之前:
/** * 說明這個類的一些 ... */ class Example { ... |
注意頂層(top-level)的類是不縮進(jìn)的,而其成員是縮進(jìn)的。描述類的文檔注釋的第一行(/**)不需縮進(jìn);隨后的文檔注釋每行都縮進(jìn)1格(使星號縱向?qū)R)。成員,包括構(gòu)造函數(shù)在內(nèi),其文檔注釋的第一行縮進(jìn)4格,隨后每行都縮進(jìn)5格。
若你想給出有關(guān)類、變量或方法的信息,而這些信息又不適合寫在文檔中,則可使用實現(xiàn)塊注釋(見5.1.1)或緊跟在聲明后面的單行注釋(見5.1.2)。例如,有關(guān)一個類實現(xiàn)的細(xì)節(jié),應(yīng)放入緊跟在類聲明后面的實現(xiàn)塊注釋中,而不是放在文檔注釋中。
文檔注釋不能放在一個方法或構(gòu)造器的定義塊中,因為程序會將位于文檔注釋之后的第一個聲明與其相關(guān)聯(lián)。
分享:PHP.MVC的模板標(biāo)簽系統(tǒng)PHP.MVC的模板標(biāo)簽系統(tǒng)(PhpMVC_Tags)現(xiàn)在提供了3種類型的標(biāo)簽:包含指令,聲明和表達(dá)式. 包含指令能讓我們將內(nèi)容分隔為許多模塊,比如:頁眉,頁腳或者內(nèi)容.包含的頁面可以是HTML,或者其他標(biāo)簽?zāi)0屙?/p>
- PHPNOW安裝Memcached擴(kuò)展方法詳解
- php記錄頁面代碼執(zhí)行時間
- PHP中獎概率的抽獎算法程序代碼
- apache設(shè)置靜態(tài)文件緩存方法介紹
- php對圖像的各種處理函數(shù)代碼小結(jié)
- PHP 關(guān)于訪問控制的和運(yùn)算符優(yōu)先級介紹
- 關(guān)于PHP語言構(gòu)造器介紹
- php/js獲取客戶端mac地址的實現(xiàn)代碼
- php5.5新數(shù)組函數(shù)array_column使用
- PHP preg_match的匹配多國語言的技巧
- php 中序列化和json使用介紹
- php采集文章中的圖片獲取替換到本地
PHP教程Rss訂閱編程教程搜索
PHP教程推薦
- 用PHP操縱Oracle的LOB類型的數(shù)據(jù)
- 創(chuàng)建論壇專業(yè)知識庫 HDWiki(For Discuz!)V1.0正式版發(fā)布
- php gzip壓縮輸出的實現(xiàn)方法
- Windows IIS環(huán)境下安裝和配置PHP開發(fā)環(huán)境
- php調(diào)用MySQL存儲過程的方法集合
- PHP 關(guān)于訪問控制的和運(yùn)算符優(yōu)先級介紹
- 解析PHP跳出循環(huán)的方法以及continue、break、exit的區(qū)別介紹
- PHP實現(xiàn)靜態(tài)發(fā)布的方法淺談
- 解析PHP程序編譯中常見錯誤信息
- 一個簡單的PHP框架實現(xiàn)方法
- 相關(guān)鏈接:
- 教程說明:
PHP教程-PHP教程:PHP編碼書寫規(guī)范(2)
。