DoitPHP編碼規範

適用範圍  如無特殊說明，以下規則要求完全適用於DoitPHP項目(註：Doitphp的PHP框架文件，而非使用DoitPHP所開發的PHP項目)。如果你喜歡以下編碼規範，也可以用在其它PHP開發專案。 

標準化的重要性和好處 “不以規矩，不成方圓”，當一個軟體專案的開發遵守公共一致的標準時，整個團隊成員形成並保持一致的編碼風格，整個專案文件如同一人所寫。每個程式設計師的程式碼都易於為他人所理解，提高了程式碼的可維護性，從而減少了軟體的維護成本。同時使新的參與者可以很快的適應環境，從而最大限度的提高團隊開發的合作效率。長期的規範編碼還可以讓開發人員養成好的編碼習慣，可以減少編碼出錯的機會,甚至鍛鍊出更加嚴謹的思維。將規範「令之以文」是為了明確我們的編碼標準。我們相信：標準不是專案成功的關鍵，但可以幫助我們在團隊協作中有更高的效率並且更順利的完成既定的任務。

PHP編碼規格與原則 1、文件格式   1.1、文件編碼：文件編碼統一為UTF-8(註:非UTF-8 BOM)。 1.2、PHP程式碼標記：任何時候都要使用「<?php ?>」定義你的PHP程式碼。而“<? ?>”將禁止使用。對於只含有php的程式碼檔案,建議將檔案結尾處的「?>」忽略掉，防止多餘空格或其它字元影響程式碼。 1.3、縮排規則：縮排使用4個空格，而不是 TAB。這已經是PHP業界的標準了，我們也不會「逆歷史潮流而動」。使用空格主要是為了程式碼美觀整齊。因為在不同的編輯器裡， TAB 製表符的長度是不一樣的，而空格則是一樣的。使用TAB按下TAB鍵能解決的問題，使用空格要按四次空白鍵，明顯影響開發效率。目前很多編輯器預設一個TAB佔用四個空格位置（佔用幾個空格，對此編輯器可以調節），如果是這樣，為了提高開發效率，可以放心大膽地使用TAB。本縮排規格也適用於JavaScript中的函數、類別、邏輯結構、迴圈等。 1.4、程式碼內容：每行結尾不允許有多餘的空格或TAB製表符（確保你的編輯器保存檔案為 Unix 格式，這表示行是以換行符終止的）。除了語言包註釋設定檔,其它地方不能有中文。 1.5、程式碼註解：文件要有清晰的程式碼註釋，註解風格採用phpDocumentor標準