首頁 >後端開發 >php教程 >http://67.220.92.14/forum/inde 講的非常好的PHP編碼規格第1/3頁

http://67.220.92.14/forum/inde 講的非常好的PHP編碼規格第1/3頁

WBOY
WBOY原創
2016-07-29 08:37:192161瀏覽

註:這是從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. 其他細部問題… 10 4.9.2. 錯誤回報等級… 11
5. 資料庫設計…. 11
5.1. 欄位… 11
5.1.1. 表與欄位命名… >5.1.2. 字段結構… 11
5.2. SQL語句… 12
5.3. 效能與效率… 13
5.3.1. 定長與變長表…13 5.3.3.運算與檢索… 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. 變數… HTML. 16
6.2.2. 變數… HTML. 16
6.2.2. 變數… 17
6.2.4. 縮排… 17
7. 檔案與目錄…. 17
7.1. 檔案命名… 17 7.2. 目錄命名… 18
空白…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)) {
///State.

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;
}
}
>switch ($str)
{
case 'abc':
$result = 'abc';
break;
default:
$result = 'unknown';
$result = 'unknown'; >break;
}

4.3.3. 運算子、小括號、空格、關鍵字與函數
每個運算子與兩邊參與運算的數值或表達式中間要有一個空格,唯一的特例是字元連接運算符號兩邊不加空格;
左括號“(” 應和函數關鍵字緊貼在一起,除此以外應使用空格將“(”同前面內容分開;
右括號“)”除後面是“)”或“.”以外,其他一律用空格隔開它們;
除字符串中特意需要,一般情況下,在程序以及HTML中不出現兩個連續的空格;
任何情況下,PHP程式中不能出現空白的帶有TAB或空格的行,即:這類空白行應不包含任何TAB或空格。同時,任何程式行尾也不能出現多餘的TAB或空格。多數編輯器具有自動去除行尾空格的功能,如果習慣養成不好,可臨時使用它,避免多餘空格產生;
每段較大的程序體,上、下應當加入空白行,兩個程式區塊之間只使用1個空白行,禁止使用多行。
程式塊劃分盡量合理,過大或過小的分割都會影響他人對程式碼的閱讀與理解。一般可以以較大函數定義、邏輯結構、功能結構來進行劃分。少於15行的程式區塊,可不加上下空白行;
說明或顯示部分中,內容如含有中文、數字、英文單字混雜,應在數字或英文單字的前後加入空格。
根據上述原則,以下舉例說明正確的書寫格式:
$result = (($a + 1) * 3 / 2 + $num)).'Test';
$condition 2 + $num)).'Test';
$condition $var) : func2($var);
$condition ? $long_statement
: $another_long_statement;
if ($flag)
{
//Statements
//Statements 15 lines
}
Showmessage('請使用 restore.php 工具還原資料。'); 

目前1/3頁 123下一頁

以上就介紹了http://67.220.92.14/forum/inde 講的非常不錯的PHP編碼規範第1/3頁,包括了http://67.220.92.14/forum/inde方面的內容,希望對PHP教程有興趣的朋友有幫助。

陳述:
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn