C++程序編碼規(guī)范

1、C+代碼風(fēng)格和編程規(guī)范txwlkj概述 目的 提高可讀性 提高可維護(hù)性 減少bug 參考參考 Google 開源項(xiàng)目風(fēng)格指南開源項(xiàng)目風(fēng)格指南 原版http:/ 中文版/en/latest/ 高質(zhì)量C+編程編譯環(huán)境 統(tǒng)一編譯環(huán)境 IDE 版本 vs2010 sp1 SDK版本 第三方類庫版本頭文件頭文件 頭文件保護(hù) 使用#define 使用#pragma once 頭文件里聲明，cpp里實(shí)現(xiàn) 前置聲明 類庫采用PIMPL范式 頭文件包含路徑和順序 #include 和 #include ”foobar.h” 不使

2、用全路徑 .和.的使用要注意，項(xiàng)目內(nèi)部可以使用 目的 避免多重包含，降低編譯依賴 提高編譯速度，減少編譯錯(cuò)誤變量作用域和命名空間 避免全局using 使用命名空間 盡量少使用全局變量 局部變量最小作用范圍（C+） 目的 避免編譯沖突 降低耦合，提高編譯執(zhí)行效率命名規(guī)則 原則 有意義，自解釋 風(fēng)格統(tǒng)一 適配原有環(huán)境 MFC的代碼用MFC的命名規(guī)則dwError、GetLastError(); Linux的代碼用linux的命名規(guī)則 慎用縮寫 cnt count studentCnt studentCount stuCnt cur current curStudent currentStudent

3、 curStu 適度使用匈牙利命名法 LPCTSTR lpszName; 使用駱駝命名法，單詞首字母大寫 int fooBar命名規(guī)則（續(xù)） 前后綴 類成員int m_foo; 全局int g_foo; const用k 例如int kFooBar 類型名 typedef struct _FILE_INFO FileInfo; 函數(shù)名 FileInfo GetFileInfo(); 變量名 FileInfo fileInfo注釋 接口要注釋 函數(shù)作用 參數(shù)類型、作用和取值范圍 返回值類型和可能的取值 復(fù)雜的邏輯要注釋 能通過名字自解釋的函數(shù)或變量不需要注釋 注釋位置 長注釋在語句塊前面 短注釋可

4、以在語句后面縮進(jìn)和排版 nginx風(fēng)格/book/appendix_a.html google風(fēng)格/en/latest/google-cpp-styleguide/formatting/ QT風(fēng)格/wiki/Qt_Coding_Style_SimplifiedChinese 大括號(hào)位置 縮進(jìn) 空格 換行函數(shù)設(shè)計(jì) 函數(shù)命名 參數(shù) 不需要更改的參數(shù)用const 參數(shù)名要自解釋 檢查參數(shù)assert 傳入引用比指針安全 返回值 返回引用類型要小心 返回函數(shù)內(nèi)部分配的內(nèi)存 函數(shù)內(nèi)部分配的內(nèi)存要特別小心 跨模塊 切分過長的函數(shù)，函數(shù)功能要單一類（class，struct） 數(shù)據(jù)成員 必須要初始化，特別是靜態(tài)變量 初始化列表順序要和定義順序相同 成員函數(shù) 不修改成員變量的函數(shù)要加const 避免多重繼承 可以多重繼承純虛類 構(gòu)造函數(shù)、析構(gòu)函數(shù) 不能拋出異常 單參數(shù)構(gòu)造函數(shù)用explict關(guān)鍵字 指針數(shù)據(jù)成員的賦值會(huì)造成懸掛指針問題 提供拷貝構(gòu)造函數(shù) 和 operator = 使用多態(tài)特性時(shí)要用虛析構(gòu)函數(shù)內(nèi)存 GC機(jī)制 包裝類 shared_ptrunique_ptr 分配和釋放 指針要初始化 分配后要判空