時間：2015/6/28來源：IT貓撲網(wǎng)作者：網(wǎng)管聯(lián)盟我要評論(0)
文件結(jié)構(gòu)
|
|――images
|――include
|――parameter
|――config
|――function
|――index
images存放圖片文件，include中是系統(tǒng)是要引用的文件，一般在parameter中存放參數(shù)文件，config中存放配置文件，function中存放方法文件，如javascript的方法等，并按功能模塊的分類，將各功能的類也放入其中
文件名
文件夾命名一般采用英文，長度一般不超過20個字符，命名采用小寫字母。除特殊情況才使用中文拼音，一些常見的文件夾命名如：images(存放圖形文件)，Flash(存放Flash文件)，style(存放CSS文件)，scripts(存放Javascript腳本)，inc(存放include文件)，link(存放友情鏈接),media(存放多媒體文件)等。文件名稱統(tǒng)一用小寫的英文字母、數(shù)字和下劃線的組合。
塊注釋
塊注釋通常用于提供對文件，方法，數(shù)據(jù)結(jié)構(gòu)和算法的描述。塊注釋被置于每個文件的開始處以及每個方法之前。它們也可以被用于其他地方，比如方法內(nèi)部。在功能和方法內(nèi)部的塊注釋應(yīng)該和它們所描述的代碼具有一樣的縮進格式。
塊注釋之首應(yīng)該有一個空行，用于把塊注釋和代碼分割開來，比如：
/*
* 這里是塊注釋
*/
塊注釋可以以/*-開頭，這樣indent(1)就可以將之識別為一個代碼塊的開始，而不會重排它。
/*-
* 如果想被忽略，可是使用特別格式的塊注釋
*
* one
* two
* three
*/
注意：如果你不使用indent(1)，就不必在代碼中使用/*-，或為他人可能對你的代碼運行indent(1)作讓步。
單行注釋
短注釋可以顯示在一行內(nèi)，并與其后的代碼具有一樣的縮進層級。如果一個注釋不能在一行內(nèi)寫完，就該采用塊注釋。單行注釋之前應(yīng)該有一個空行。以下是一個代碼中單行注釋的例子：
if (condition) {
/* 以下代碼運行的條件 */
...
}
尾端注釋
極短的注釋可以與它們所要描述的代碼位于同一行，但是應(yīng)該有足夠的空白來分開代碼和注釋。若有多個短注釋出現(xiàn)于大段代碼中，它們應(yīng)該具有相同的縮進。
以下是一個代碼中尾端注釋的例子：
if ($a == 2) {
return TRUE; /* 對單一條件的說明 */
} else {
return isPrime($a); /* 其余的條件 */
}
行末注釋
注釋界定符"//"，可以注釋掉整行或者一行中的一部分。它一般不用于連續(xù)多行的注釋文本;然而，它可以用來注釋掉連續(xù)多行的代碼段。以下是所有三種風(fēng)格的例子：
if ($foo > 1) {
// 第二種用法.
...
}
else {
return false; // 說明返回值的原因
}
//if ($bar > 1) {
//
// // 第三種用法
// ...
//}
//else {
// return false;
//}
文檔注釋
文檔注釋描述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)。
關(guān)鍵詞標(biāo)簽：PHP編碼規(guī)范
相關(guān)閱讀
熱門文章
plsql developer怎么連接數(shù)據(jù)庫-plsql deve
2021年最好用的10款php開發(fā)工具推薦
在 PHP 中使用命令行工具
php應(yīng)用程序安全防范技術(shù)研究
人氣排行 詳解ucenter原理及第三方應(yīng)用程序整合思路、方法PHP中防止SQL注入攻擊PHP會話Session的具體使用方法解析PHP運行出現(xiàn)Notice : Use of undefined constant 的解決辦法CakePHP程序員必須知道的21條技巧PHP如何清空mySQL數(shù)據(jù)庫PHP采集圖片實例（PHP采集）plsql developer怎么連接數(shù)據(jù)庫-plsql developer連接數(shù)據(jù)庫方法