C++編碼規(guī)范

第0章 為什么要用C++ 
0.1 原因 
0.2 語言的發(fā)展和代碼復用 
0.3 代碼復用的特點 
0.4 代碼復用對我們的影響 
第1章 命名原則 
原則1.1 關于類型名 
原則1.2 關于變量和函數(shù)名 
原則1.3 關于全大寫的函數(shù)名(建議) 
原則1.4 關于宏、常量和模板名 
原則1.5 關于指針標識符名(供參考) 
原則1.6 關于變量名前綴(供參考) 
原則1.7 關于匿名命名空間級標識符的前綴 
原則1.8 減少匿名命名空間級標識符 
原則1.9 命名時避免使用國際組織占用的格式 
原則1.10 名字要本著清楚、簡單的原則 
原則1.11 盡量用可發(fā)音的名字 
原則1.12 盡量用英文命名 
原則1.13 盡量選擇通用詞匯并貫穿始終 
原則1.14 避免用模棱兩可、晦澀或不標準的縮寫 
原則1.15 避免使用會引起誤解的詞匯 
原則1.16 減少名字中的冗余信息 
原則1.17 建議起名盡量通俗，太專一會限制以后的擴展 
原則1.18 名字最好盡可能精確地表達其內容 
原則1.19 避免名字中出現(xiàn)形狀混淆的字母或數(shù)字 
原則1.20 命名類和成員使得“object.method()”有意義 
原則1.21 類和對象名應是名詞 
原則1.22 實現(xiàn)行為的類成員函數(shù)名應是動詞 
原則1.23 類的存取和查詢成員函數(shù)名應是名詞或形容詞 
原則1.24 變量名應是名詞 
原則1.25 布爾型的名字要直觀 
原則1.26 關于函數(shù)的左值參數(shù)和右值參數(shù)名 
原則1.27 避免局部名和外層的名字沖突 
原則1.28 用a、an、any區(qū)分重名(參數(shù)) 
原則1.29 模板類型名應有意義 
第2章 類型的使用 
原則2.1 避免隱式聲明類型 
原則2.2 慎用無符號類型 
原則2.3 少用浮點數(shù)除非必須 
原則2.4 用typedef簡化程序中的復雜語法 
原則2.5 少用union 
原則2.6 慎用位操作 
原則2.7 用enum取代(一組相關的)常量 
原則2.8 使用內置bool類型 
原則2.9 (盡量)用引用取代指針 
第3章 函數(shù) 
原則3.1 一定要做到先定義后使用 
原則3.2 函數(shù)原型聲明放在一個頭文件中 
原則3.3 函數(shù)無參數(shù)一定要用void標注 
原則3.4 對于內置類型參數(shù)應傳值(除非函數(shù)內部要對其修改) 
原則3.5 對于非內置類型參數(shù)應傳遞引用(首選)或指針 
原則3.6 關于何時用指針傳遞參數(shù) 
原則3.7 避免使用參數(shù)不確定的函數(shù) 
原則3.8 若不得不使用參數(shù)不確定的函數(shù)，用<stdarg.h>提供的方法 
原則3.9 避免函數(shù)的參數(shù)過多 
原則3.10 盡量保持函數(shù)只有唯一出口 
原則3.11 顯式定義返回類型 
原則3.12 (非void)任何情況都要有返回值 
原則3.13 若函數(shù)返回狀態(tài)，嘗試用枚舉作類型 
原則3.14 返回指針類型的函數(shù)應該用NULL表示失敗 
原則3.15 函數(shù)盡量返回引用(而不是值) 
原則3.16 若必須返回值，不要強行返回引用 
原則3.17 當函數(shù)返回引用或指針時，用文字描述其有效期 
原則3.18 禁止成員函數(shù)返回成員(可讀寫)的引用或指針 
原則3.19 重復使用的代碼用函數(shù)替代 
原則3.20 關于虛友元函數(shù) 
原則3.21 關于虛構造函數(shù) 
第4章 類的設計和聲明 
原則4.1 類應是描述一組對象的集合 
原則4.2 類成員應是私有的(private) 
原則4.3 保持對象狀態(tài)信息的持續(xù)性 
原則4.4 提高類內聚合度 
原則4.5 降低類間的耦合度 
原則4.6 努力使類的接口少而完備 
原則4.7 保持類的不同接口在實現(xiàn)原則上的一致性 
原則4.8 保持不同類的接口在實現(xiàn)原則上的一致性 
原則4.9 避免為每個類成員提供訪問函數(shù) 
原則4.10 不要在類定義時提供成員函數(shù)體 
原則4.11 函數(shù)聲明(而不是實現(xiàn))時定義參數(shù)的缺省值 
原則4.12 恰當選擇成員函數(shù)、全局函數(shù)和友元函數(shù) 
原則4.13 防范、杜絕潛在的二義性 
原則4.14 顯式禁止編譯器自動生成不需要的函數(shù) 
原則4.15 當遇到錯誤時對象應該應對有度 
原則4.16 用嵌套類的方法減少匿名命名空間類的數(shù)量 
第5章 (面向對象的)繼承 
原則5.1 “公共繼承(public inheritance)”意味著“派生類是基類” 
原則5.2 關于“有”和“由...實現(xiàn)” 
原則5.3 關于繼承和模板(template)的區(qū)別 
原則5.4 關于繼承接口和繼承實現(xiàn) 
原則5.5 限制繼承的層數(shù) 
原則5.6 繼承樹上非葉子節(jié)點的類應是虛基類 
原則5.7 顯式提供繼承和訪問修飾：public、protected或private 
原則5.8 顯式指出繼承的虛函數(shù) 
原則5.9 基類析構函數(shù)(destructor)首選是虛函數(shù) 
原則5.10 絕不要重新定義(繼承來的)非虛函數(shù) 
原則5.11 絕不要重新定義缺省參數(shù)值 
原則5.12 不要將基類強制轉換成派生類
原則5.13 關于C++中的分支用法選擇 
原則5.14 慎用多重繼承 
原則5.15 所有多重繼承的基類析構函數(shù)都應是虛函數(shù) 
第6章 內存分配和釋放 
原則6.1 用new、delete取代malloc、calloc、realloc和free 
原則6.2 new、delete和new[]、delete[]要成對使用 
原則6.3 確保所有new出來的東西適時被delete掉 
原則6.4 誰申請誰釋放 
原則6.5 當對象消亡時確保指針成員指向的系統(tǒng)堆內存全部被釋放 
原則6.6 自定義類的new/delete操作符一定要符合原操作符的行為規(guī)范 
原則6.7 自定義類的new操作符一定要自定義類的delete操作符 
原則 6.8 當所指的內存被釋放后，指針應有一個合理的值 
原則6.9 記住給字符串結束符申請空間 
第7章 初始化和清除 
原則7.1 聲明后就初始化強于使用前才初始化 
原則7.2 初始化要徹底 
原則7.3 確保每一個構造函數(shù)都實現(xiàn)完全的初始化 
原則7.4 盡量使用初始化列表 
原則7.5 初始化列表要按成員聲明順序初始化它們 
原則7.6 構造函數(shù)沒結束，對象就沒有構造出來 
原則7.7 不要用構造函數(shù)初始化靜態(tài)成員 
原則7.8 拷貝構造函數(shù)和賦值函數(shù)盡量用常量參數(shù) 
原則7.9 讓賦值函數(shù)返回當前對象的引用 
原則7.10 在賦值函數(shù)中防范自己賦值自己 
原則7.11 拷貝和賦值要確保徹底 
原則7.12 關于構造函數(shù)、析構函數(shù)、賦值函數(shù)、相等或不等函數(shù)的格式 
原則7.13 為大多數(shù)類提供缺省和拷貝構造函數(shù)、析構函數(shù)、賦值函數(shù)、相等函數(shù) 
原則7.14 只有在有意義時才提供缺省構造函數(shù) 
原則7.15 包含資源管理的類應自定義拷貝構造函數(shù)、賦值函數(shù)和析構函數(shù) 
原則7.16 拷貝構造函數(shù)、賦值函數(shù)和析構函數(shù)要么全自定義，要么全生成 
原則7.17 類應有自己合理的拷貝原則：或淺拷貝或深拷貝 
原則7.18 若編譯時會完全初始化，不要給出數(shù)組的尺寸 
原則7.19 將循環(huán)索引的初值定在循環(huán)點附近 
原則7.20 確保全局變量在使用前被初始化 
第8章 常量 
原則8.1 關于常量修飾符的含義 
原則8.2 在設計函數(shù)原型時，對那些不可能被修改的參數(shù)用常量修飾 
原則8.3 類成員可以轉換成常量形式暴露出來 
原則8.4 關于常量成員函數(shù) 
原則8.5 不要讓常量成員函數(shù)修改程序的狀態(tài) 
原則8.6 不要將常量強制轉換成非常量 
原則8.7 任何變量和成員函數(shù)，首選用const修飾 
第9章 重載 
原則9.1 仔細區(qū)分帶缺省值參數(shù)的函數(shù)和重載函數(shù) 
原則9.2 確保重載函數(shù)的所有版本有共同的目的和相似的行為 
原則9.3 避免重載在指針和整型類型上 
原則9.4 盡量避免重載在模板類型上 
第10章 操作符 
原則10.1 遵守操作符原本的含義，不要創(chuàng)新 
原則10.2 確保自定義操作符能和其他操作符混合使用 
原則10.3 區(qū)分作為成員函數(shù)和作為友元的操作符 
原則10.4 關于前后綴操作符 
原則10.5 確保相關的一組操作符行為統(tǒng)一 
原則10.6 絕不要自定義operator&&()、operator||()和operator,() 
第11章 類型轉換 
原則11.1 盡量避免強制類型轉換 
原則11.2 如果不得不做類型轉換，盡量用顯式方式 
原則11.3 使用新型的類型轉換并確保選擇正確 
原則11.4 用虛函數(shù)方式取代dynamic_cast 
原則11.5 自定義類最好提供顯式而不是隱式轉換函數(shù) 
原則11.6 用關鍵字explicit防止單參數(shù)構造函數(shù)的類型轉換功能 
原則11.7 限制隱式類型轉換的類型數(shù) 
原則11.8 避免多個函數(shù)提供相同的類型轉換 
第12章 友元 
原則12.1 少用友元 
原則12.2 減少擁有友元特權的個數(shù) 
第13章 模板 
原則13.1 使用模板如果有限制條件一定要在注釋和文檔中描述清楚 
原則13.2 模板類型應傳引用/指針而不是值 
原則13.3 注意模板編譯的特殊性 
原則13.4 嵌套template的>>中間要加空格以區(qū)別于operator>> 
第14章 表達式和控制流程 
原則14.1 讓表達式直觀 
原則14.2 避免在表達式中用賦值語句 
原則14.3 不能將枚舉類型進行運算后再賦給枚舉變量 
原則14.4 避免對浮點類型做等于或不等于判斷 
原則14.5 嘗試用范圍比較代替精確比較 
原則14.6 范圍用包含下限不包含上限方式表示 
原則14.7 關于goto 
原則14.8 在循環(huán)過程中不要修改循環(huán)計數(shù)器 
第15章 宏 
原則15.1 徹底用常量替代(類似功能的)宏 
原則15.2 代碼中的數(shù)值應由一個有意義的標識符代替 
原則15.3 若宏值多于一項，一定要使用括號 
原則15.4 不要用分號結束宏定義 
原則15.5 徹底用inline函數(shù)替代(類似功能的)宏函數(shù) 
原則15.6 不好被替代的宏函數(shù) 
原則15.7 函數(shù)宏的每個參數(shù)都要括起來 
原則15.8 不帶參數(shù)的宏函數(shù)也要定義成函數(shù)形式 
原則15.9 用{}將函數(shù)宏的函數(shù)體括起來 
原則15.10 徹底用typedef代替宏定義新類型 
原則15.11 不要在公共頭文件中定義宏 
原則15.12 不要用宏改寫語言 
第16章 異常(exception)處理 
原則16.1 確保代碼在異常出現(xiàn)時能正確處理 
原則16.2 正確注釋代碼的異常處理能力 
原則16.3 減少不必要的異常處理 
原則16.4 不要利用異常處理機制處理其他功能 
原則16.5 注意模板類型可能會破壞異常處理的一些約定 
原則16.6 確保異常發(fā)生后資源還能被回收 
原則16.7 特別當心析構時發(fā)生異常 
原則16.8 拋出的異常最好是一個對象 
原則16.9 捕捉異常時絕不要先基類后派生類 
原則16.10 捕捉異常時用引用 
第17章 代碼格式 
原則17.1 水平縮進每次用兩個空格 
原則17.2 不要在引用操作符前后加空格 
原則17.3 不要在單目操作符和其操作對象間加空格 
原則17.4 不要在“::”前后加空格 
原則17.5 在“,"";”之后(而不是之前)加空格 
原則17.6 在關鍵字和其后的“(”間加一個空格 
原則17.7 文件中的主要部分用空行分開 
原則17.8 函數(shù)間要用空行分開 
原則17.9 組局部變量聲明和代碼之間用空行分開 
原則17.10 用空行將代碼按邏輯片斷劃分 
原則17.11 可以考慮將if塊和else/else if塊用空行分開 
原則17.12 函數(shù)返回語句要和其他語句用空行分開 
原則17.13 每一行不超過78個字符 
原則17.14 當一條語句超過78個字符時按邏輯劃分成不同行 
原則17.15 花括號{}要單獨占一行 
原則17.16 花括號中沒有或只有一條語句時也不省略花括號 
原則17.17 不要在一行中放多于一條語句 
原則17.18 語句switch中的每個case各占一行 
原則17.19 語句switch中的case按字母順序排列 
原則17.20 為所有switch語句提供default分支 
原則17.21 若某個case不需要break一定要加注釋聲明 
原則17.22 變量定義應集中放置、各占一行，并按字母順序排列 
原則17.23 定義指針和引用時*和&緊跟類型 
原則17.24 按編譯器解析順序放置變量聲明的修飾符 
原則17.25 關于函數(shù)聲明和定義的格式 
原則17.26 函數(shù)名和左括號間不要空格 
原則17.27 聲明函數(shù)時給出參數(shù)的名字，除非沒有用處 
原則17.28 關于類內不同級別的元素排列順序 
原則17.29 關于類成員函數(shù)的排列順序 
原則17.30 類成員變量按字母順序排列 
原則17.31 關于靜態(tài)成員的訪問 
原則17.32 關于字符常量 
原則17.33 用帶顏色的編輯器 
第18章 注釋 
原則18.1 用英語寫全部的注釋 
原則18.2 確保注釋完善你的代碼，而不是重復你的代碼 
原則18.3 注釋用詞要精確，不能有二義性 
原則18.4 注釋中的術語要通用 
原則18.5 注釋要簡單、清楚、切中要害 
原則18.6 注釋不能超出被注釋代碼所包含的內容 
原則18.7 注釋中避免引用容易變化的信息 
原則18.8 確保所有注釋(隨代碼)及時更新 
原則18.9 注釋不具備約束使用者行為的能力 
原則18.10 注釋不要嵌套 
原則18.11 不要用/**/注釋掉(大塊)代碼，應該用#if 0 
原則18.12 區(qū)分“戰(zhàn)略性”注釋和“戰(zhàn)術性”注釋 
原則18.13 行末注釋盡量對齊 
原則18.14 單獨的注釋行和被注釋語句縮進相同的空格 
原則18.15 減少不必要的單獨占一行的注釋 
原則18.16 對每個#else或#endif給出行末注釋 
原則18.17 對每個引用的頭文件給出行末注釋 
原則18.18 對每個空循環(huán)體給出確認性注釋 
原則18.19 關于函數(shù)注釋 
原則18.20 關于注釋頻率 
第19章 文件和目錄 
原則19.1 使用統(tǒng)一而且通用的文件名后綴 
原則19.2 關于文件名的選擇 
原則19.3 關于文件/目錄名的字符集選擇 
原則19.4 關于每個類的文件組成 
原則19.5 關于模板類的文件安排 
原則19.6 保持文件前言的簡潔性 
原則19.7 關于文件的段落安排 
原則19.8 關于目錄組織 
第20章 頭文件 
原則20.1 頭文件多次引用的防范 
原則20.2 確保公共頭文件的自足性 
原則20.3 只引用需要的頭文件 
原則20.4 引用時""和<>的用法 
原則20.5 引用頭文件的順序 
原則20.6 引用時不要用絕對路徑 
原則20.7 將函數(shù)庫放在一個單獨的目錄下引用 
原則20.8 不要在頭文件中定義常量/變量 
原則20.9 任何聲明若被多個源文件引用則應在一個頭文件中 
原則20.10 在源文件中不要用關鍵字extern 
第21章 條件編譯 
原則21.1 最小化條件編譯的使用范圍 
原則21.2 若使用#if或#ifdef，不要遺漏#else 
原則21.3 編譯條件的含義要具體 
原則21.4 對復雜的編譯條件用括號使其清晰 
原則21.5 條件編譯和普通條件語句不要混合使用 
原則21.6 若只測試某符號是否存在，不要給該符號賦值 
第22章 編譯 
原則22.1 關注編譯時的警告(warning)錯誤 
原則22.2 把問題盡量暴露在編譯時而不是運行時 
原則22.3 減少文件的依賴程度 
原則22.4 減少編譯時間 
原則22.5 透徹研究編譯器 
第23章 兼容性 
原則23.1 遵守ANSI C和ISO C++國際標準 
原則23.2 將不符合國際標準的代碼與其他代碼分開 
原則23.3 不要假設字符類型是否是有符號類型 
原則23.4 運算時顯式轉換有符號和無符號類型 
原則23.5 注意雙字節(jié)字符的兼容性 
原則23.6 恰當使用位操作符 
原則23.7 注意位域(bitfield)變量的兼容性問題 
原則23.8 不要強制引用/指針指向尺寸不同的目標 
原則23.9 確保類型轉換不會丟失信息 
原則23.10 不要假設類型的存儲尺寸 
原則23.11 如果一定要規(guī)定類型的存儲尺寸 
原則23.12 不要假設對象(等數(shù)據(jù)結構)的存儲結構 
原則23.13 注意運算溢出問題 
原則23.14 不要假設表達式的運算順序 
原則23.15 不要假設函數(shù)參數(shù)的計算順序 
原則23.16 不要假設不同源文件中靜態(tài)或全局變量的初始化順序 
原則23.17 不要依賴編譯器基于實現(xiàn)、未明確或未定義的功能 
原則23.18 注意數(shù)據(jù)文件的兼容性 
原則23.19 注意引用公共庫的兼容性 
原則23.20 一定不要重新實現(xiàn)標準庫函數(shù) 
原則23.21 將所有#include的文件名視為大小寫敏感 
原則23.22 代碼中用到的路徑只用“/”而不要用“/” 
原則23.23 確保main()函數(shù)總是返回一個整型 
原則23.24 不要依賴pragmas 
第24章 性能 
原則24.1 使用性能追蹤分析工具 
原則24.2 不要用移位代替乘除運算 
原則24.3 如無必要，不要用非int的整型類型 
原則24.4 不要使用關鍵字register 
原則24.5 避免在循環(huán)體內部定義對象 
原則24.6 減少代價很高的對象拷貝 
原則24.7 減少臨時對象 
原則24.8 注意大尺寸對象數(shù)組 
原則24.9 返回對象(值)的優(yōu)化 
原則24.10 前綴++和--的效率更高 
原則24.11 恰當使用遞歸 
原則24.12 恰當?shù)厥褂胕nline函數(shù) 
原則24.13 虛函數(shù)和虛繼承效率會有一點損失 
原則24.14 如果合理，使用編譯器生成的函數(shù) 
原則24.15 如果合理，構造直傳類 
原則24.16 關于緩存(cache)類成員 
原則24.17 關于標準庫的性能 
原則24.18 關于偷懶 
原則24.19 關于勤快 
原則24.20 80－20原則 
第25章 其他 
原則25.1 避免產(chǎn)生全局數(shù)據(jù)對象 
原則25.2 確保任何定義只發(fā)生一次 
原則25.3 指針操作中用NULL代替0 
原則25.4 不要把NULL用在指針以外的領域 
原則25.5 不要弄巧成拙 
原則25.6 將不再使用的代碼刪掉 
原則25.7 運行時不要改變進程的環(huán)境變量 
原則25.8 該用volatile時一定要用 
原則25.9 不要使用鮮為人知的替換符號 
原則25.10 關于代碼審查(code inspection/review)規(guī)范 
附錄 供參考的源代碼