Linux專案組程式設計規範

前言： 本手冊以林銳博士編寫的《高質量 C++/C 程式設計指南》內容為參考，根據專案組成員的經驗總結和共同協定，稍作簡潔和修改。本規範手冊分成兩部分： 第一部分：以條款的形式列出了專案組程式設計的規則和建議，規則是指專案組成員必須要遵守的程式設計規範，建議是指推薦使用的程式設計風格。 第二部分：是對第一部分規則和建議的詳細說明。建議先仔細閱讀第二部分，在已經瞭解了每條規則和建議的真正意義以及為什麼要遵守的基礎上，在實際專案程式設計時可以透過直接查閱第一部分來實現快速規範程式碼的目的。 本手冊由Linux專案組成員共同制定，暫時處於beta版本，由於我們經驗有限，對本手冊的任何建議和批評都歡迎各位提出，我們將虛心接受。 Linux專案組 2009-4-23 第一部分： 第 1 章 檔案結構 【規則 1-1】為了防止標頭檔案被重複引用，應當用 ifndef/define/endif 結構產生預處理塊； 【規則1-2】標頭檔案由三部分內容組成： (1) 標頭檔案開頭處的版權和版本宣告(參見第二部分示例 1-1) (2) 預處理塊 (3) 函式和類結構宣告等 【規則1-3】定義檔案由三部分內容組成： (1) 定義檔案開頭處的版權和版本宣告(參見示例 1-1)。 (2) 對一些標頭檔案的引用 (3) 程式的實現體(包括資料和程式碼) 【規則1-4】不提倡使用全域性變數，儘量不要在標頭檔案中出現象 extern int value 這類宣告。 【建議 1-5】標頭檔案中只存放“宣告”而不存放“定義”。建議將成員函式的定義與宣告分開，不論該函式體有多麼小； 第 2章 程式的版式 【規則2-1】在每個函式定義結束之後都要加空行； 【規則2-2】在一個函式體內，邏揖上密切相關的語句之間不加空行，其它地方應加空行分隔； 【規則2-3】一行程式碼只做一件事情，如只定義一個變數，或只寫一條語句。這樣的程式碼容易閱讀，並且方便於寫註釋； 【規則2-4】if、for、while 、do 等語句自佔一行，執行語句不得緊跟其後。不論執行語句有多少都要加{}。這樣可以防止書寫失誤。程式的分界符‘{’和‘}’應獨佔一行並且位於同一列，同時與引用它們的語句左對齊； 【規則2-5】‘，’ ‘;’向前緊跟，緊跟處不留空格。 ‘，’之後要留空格，如Function(x, y, z) 。如果‘;’不是一行的結束符號，其後要留空格，如for (initialization; condition; update)； 【規則2-6】賦值運算子、比較運算子、算術運算子、邏輯運算子、位域運算子，如“=”、“+=”“>=”、“”這類運算子前後不加空格； 【規則2-9】應當將修飾符*和＆緊靠變數； 【規則2-10】如果程式碼本來就是清楚的，則不必加註釋。否則多此一舉，令人厭煩。例如i++; // i加1，多餘的註釋； 【規則2-11】註釋的位置應與被描述的程式碼相鄰，可以放在程式碼的上方或右方，不可放在下方； 【規則2-12】儘可能在定義變數的同時初始化該變數(就近原則)； 【建議2-13】程式碼行最大長度宜控制在70至80個字元以內。程式碼行不要過長，否則眼睛看不過來，也不便於列印； 【建議2-14】長表示式要在低優先順序運算子處拆分成新行，運算子放在新行之首(以便突出運算子)。拆分出的新行要進行適當的縮排，使排版整齊，語句可讀； 【建議2-15】註釋是對程式碼的“提示”，而不是文件。程式中的註釋不可喧賓奪主，註釋太多了會讓人眼花繚亂。註釋的花樣要少； 【建議2-16】邊寫程式碼邊註釋，修改程式碼同時修改相應的註釋，以保證註釋與程式碼的一致性。不再有用的註釋要刪除； 【建議2-17】註釋應當準確、易懂，防止註釋有二義性。錯誤的註釋不但無益反而有害； 【建議2-18】儘量避免在註釋中使用縮寫，特別是不常用縮寫； 【建議2-19】當程式碼比較長，特別是有多重巢狀時，應當在一些段落的結束處加註釋，便於閱讀。 【建議2-20】對於表示式比較長的for 語句和if 語句，為了緊湊起見可以適當地去掉一些空格，如for (i=0; i<10 linux default>[@more@]