講的非常不錯的PHP編碼規範第1/3頁

註：這是從PHPCMS開發文檔裡看到編碼規範，雖名為PHPCMS的開發規範，但我覺得所有的PHP編程都該如此。寫了那麼多PHP，很多編碼對照這規範都感覺欠缺很多，今後一定要對照糾正。

Phpcms 編碼規範
1. 引言…. 2
2. 適用範圍…. 2
3. 標準化的重要性和好處…. 3
4. PHP編碼規範與原則…. 3
4.1. 代碼標記… 3
4.2. 注釋… 3
4.3. 書寫規則… 4
4.3.1. 縮排… 4
4.3.2. 大括弧{}、if和switch. 4
4.3.3. 運算子、小括弧、空格、關鍵詞和函數… 5
4.3.4. 函數定義… 6
4.3.5. 引號… 6
4.3.6. 多語言問題… 7
4.4. 命名原則… 8
4.4.1. 變數、對象、函數名… 8
4.4.2. 常量… 8
4.5. 變數的初始化與邏輯檢查… 8
4.6. 安全性… 9
4.7. 相容性… 9
4.8. 代碼重用… 10
4.9. 其他細節問題… 10
4.9.1. 包含調用… 10
4.9.2. 錯誤報表層級… 11
5. 資料庫設計…. 11
5.1. 欄位… 11
5.1.1. 表和欄位命名… 11
5.1.2. 欄位結構… 11
5.2. SQL語句… 12
5.3. 效能與效率… 13
5.3.1. 定長與變長表… 13
5.3.2. 運算與檢索… 13
5.3.3. 結構最佳化與索引最佳化… 14
5.3.4. 查詢最佳化… 14
5.3.5. 相容性問題… 16
6. 模板設計…. 16
6.1. 代碼標記… 16
6.2. 書寫規則… 16
6.2.1. HTML. 16
6.2.2. 變數… 16
6.2.3. 語言元素… 17
6.2.4. 縮排… 17
7. 檔案與目錄…. 17
7.1. 檔案命名… 17
7.2. 目錄命名… 18
7.3. 空目錄索引… 18

1. 引言
本規範由編程原則組成，融合并提煉了開發人員長時間積累下來的成熟經驗，意在協助形成良好一致的編程風格。以達到事半功倍的效果，如果有需要本文檔會不定期更新。
著作權： 陝西玖肆陸陸網路科技有限公司，保留所有權利
最後更新日期：年11月20日 2006

2. 適用範圍
如無特殊說明，以下規則要求完全適用於phpcms項目，同時也可大部分適用於公司其他PHP項目。

3. 標準化的重要性和好處
當一個軟體項目嘗試著遵守公用一致的標準時，可以使參與項目的開發人員更容易瞭解項目中的代碼、弄清程式的狀況。使新的參與者可以很快的適應環境，防止部分參與者出於節省時間的需要，自創一套風格並養成終生的習慣，導致其它人在閱讀時浪費過多的時間和精力。而且在一致的環境下，也可以減少編碼出錯的機會。缺陷是由於每個人的標準不同，所以需要一段時間來適應和改變自己的編碼風格，暫時性的降底了工作效率。從使項目長遠健康的發展以及後期更高的團隊工作效率來考慮暫時的工作效率降低是值得的，也是必須要經過的一個過程。標準不是項目成功的關鍵，但可以協助我們在團隊協作中有更高的效率並且更加順利的完成既定的任務。
1. 程式員可以瞭解任何代碼，弄清程式的狀況
2. 新人可以很快的適應環境
3. 防止新接觸PHP的人出於節省時間的需要，自創一套風格並養成終生的習慣
4. 防止新接觸PHP的人一次次的犯同樣的錯誤
5. 在一致的環境下，人們可以減少犯錯的機會
6. 程式員們有了一致的敵人

4. PHP編碼規範與原則

4.1.代碼標記
PHP程式可以使用或來界定 PHP 代碼，在HTML頁面中嵌入純變數時，可以使用這樣的形式。
近年來PHP開發組一直倡導代碼正常化和標準化，未來版本PHP可能會開始不建議使用甚至取消和這種速記形式，因此為了加強程式相容性，在發布之前我們將統一把

4.2.注釋
注釋是對於那些容易忘記作用的代碼添加簡短的介紹性內容。請使用 C 樣式的注釋“/* */”和標準 C++ 注釋“//”。

程式開發中難免留下一些臨時代碼和調試代碼，此類代碼必須添加註釋，以免日後遺忘。所有臨時性、調試性、實驗性的代碼，必須添加統一的注釋標記“//debug”並後跟完整的注釋資訊，這樣可以方便在程式發布和最終調試前批量檢查程式中是否還存在有疑問的代碼。例如：
$num = 1;
$flag = TRUE; //debug 這裡不能確定是否需要對$flag進行賦值
if(empty($flag)) {
//Statements
}

4.3.書寫規則

4.3.1. 縮排
每個縮排的單位約定是一個TAB(8個空白字元寬度)，需每個參與項目的開發人員在編輯器(UltraEdit、EditPlus、Zend Studio等)中進行強制設定，以防在編寫代碼時遺忘而造成格式上的不規範。
本縮排規範適用於PHP、JavaScript中的函數、類、邏輯結構、迴圈等。

4.3.2. 大括弧{}、if和switch
首括弧與關鍵詞同行，尾括弧與關鍵字同列；
if結構中，if和elseif與前後兩個圓括弧同行，左右各一個空格，所有大括弧都單獨另起一行。另外，即便if後只有一行語句，仍然需要加入大括弧，以保證結構清晰；
switch結構中，通常當一個case塊處理後，將跳過之後的case塊處理，因此大多數情況下需要添加break。break的位置視程式邏輯，與case同在一行，或新起一行均可，但同一switch體中，break的位置格式應當保持一致。
以下是符合上述規範的例子：
If ($condition)
{
switch ($var)
{
case 1: echo ‘var is 1'; break;
case 2: echo ‘var is 2'; break;
default: echo ‘var is neither 1 or 2'; break;
}
}
else
{
switch ($str)
{
case ‘abc':
$result = ‘abc';
break;
default:
$result = ‘unknown';
break;
}
}

4.3.3. 運算子、小括弧、空格、關鍵詞和函數
每個運算子與兩邊參與運算的值或運算式中間要有一個空格，唯一的特例是字元串連運算子號兩邊不加空格；
左括弧“(” 應和函數關鍵詞緊貼在一起，除此以外應當使用空格將“(”同前面內容分開；
右括弧“)”除後面是“)”或者“.”以外，其他一律用空格隔開它們；
除字串中特意需要，一般情況下，在程式以及HTML中不出現兩個連續的空格；
任何情況下，PHP程式中不能出現空白的帶有TAB或空格的行，即：這類空白行應當不包含任何TAB或空格。同時，任何程式行尾也不能出現多餘的TAB或空格。多數編輯器具有自動去除行尾空格的功能，如果習慣養成不好，可臨時使用它，避免多餘空格產生；
每段較大的程式體，上、下應當加入空白行，兩個程式塊之間只使用1個空行，禁止使用多行。
程式塊劃分盡量合理，過大或者過小的分割都會影響他人對代碼的閱讀和理解。一般可以以較大函數定義、邏輯結構、功能結構來進行劃分。少於15行的程式塊，可不加上下空白行；
說明或顯示部分中，內容如含有中文、數字、英文單詞混雜，應當在數字或者英文單詞的前後加入空格。

根據上述原則，以下舉例說明正確的書寫格式：
$result = (($a + 1) * 3 / 2 + $num)).'Test';
$condition ? func1($var) : func2($var);
$condition ? $long_statement
: $another_long_statement;
if ($flag)
{

//Statements
//More than 15 lines
}
Showmessage(‘請使用 restore.php 工具恢複資料。');