Google C++ 程式設計風格指南:命名約定
最重要的一致性規則是命名管理. 命名風格快速獲知名字代表是什麼東東: 型別? 變數? 函式? 常量? 宏 … ? 甚至不需要去查詢型別宣告. 我們大腦中的模式匹配引擎可以非常可靠的處理這些命名規則.
命名規則具有一定隨意性, 但相比按個人喜好命名, 一致性更重, 所以不管你怎麼想, 規則總歸是規則.
6.1. 通用命名規則
函式命名,變數命名,檔案命名要有描述性;少用縮寫。
儘可能給有描述性的命名,別心疼空間,畢竟讓程式碼易於新讀者理解很重要。不要用只有專案開發者能理解的縮寫,也不要透過砍掉幾個字母來縮寫單詞。
int price_count_reader; // 無縮寫int num_errors; // “num” 本來就很常見int num_dns_connections; // 人人都知道 “DNS” 是啥
int n; // 莫名其妙。int nerr; // 怪縮寫。int n_comp_conns; // 怪縮寫。int wgc_connections; // 只有貴團隊知道是啥意思。int pc_reader; // "pc" 有太多可能的解釋了。int cstmr_id; // 有刪減若干字母。
6.2. 檔案命名
檔名要全部小寫, 可以包含下劃線 (_
) 或連字元 (-
). 按專案約定來. 如果並沒有專案約定,”_” 更好。
可接受的檔案命名:
* my_useful_class.cc * my-useful-class.cc* myusefulclass.cc * muusefulclass_test.cc // ``_unittest`` 和 ``_regtest`` 已棄用。
C++ 檔案要以 .cc
結尾, 標頭檔案以 .h
結尾. 專門插入文字的檔案則以 .inc
結尾,參見 。
不要使用已經存在於 /usr/include
下的檔名 (Yang.Y 注: 即編譯器搜尋系統標頭檔案的路徑), 如 db.h
.
通常應儘量讓檔名更加明確. http_server_logs.h
就比 logs.h
要好. 定義類時檔名一般成對出現, 如 foo_bar.h
和 foo_bar.cc
, 對應於類 FooBar
.
行內函數必須放在 .h
檔案中. 如果行內函數比較短, 就直接放在 .h
中.
6.3. 型別命名
型別名稱的每個單詞首字母均大寫, 不包含下劃線: MyExcitingClass
, MyExcitingEnum
.
所有型別命名 —— 類, 結構體, 型別定義 (typedef
), 列舉 —— 均使用相同約定. 例如:
// classes and structsclass UrlTable { ...class UrlTableTester { ...struct UrlTableProperties { ...// typedefstypedef hash_mapPropertiesMap;// enumsenum UrlTableErrors { ...
6.4. 變數命名
變數名一律小寫, 單詞之間用下劃線連線. 類的成員變數以下劃線結尾, 但結構體的就不用,如:: a_local_variable
, a_struct_data_member
, a_class_data_member_
.
普通變數命名:
舉例:
string table_name; // 可 - 用下劃線。string tablename; // 可 - 全小寫。
Warning
string tableName; // 差 - 混合大小寫。
類資料成員:
不管是靜態的還是非靜態的,類資料成員都可以和普通變數一樣, 但要接下劃線。
class TableInfo { ... private: string table_name_; // 可 - 尾後加下劃線。 string tablename_; // 可。 static Pool* pool_; // 可。};
結構體變數:
不管是靜態的還是非靜態的,結構體資料成員都可以和普通變數一樣, 不用像類那樣接下劃線:
struct UrlTableProperties { string name; int num_entries; }
結構體與類的討論參考 一節.
全域性變數:
對全域性變數沒有特別要求, 少用就好, 但如果你要用, 可以用
g_
或其它標誌作為字首, 以便更好的區分區域性變數.
6.5. 常量命名
在全域性或類裡的常量名稱前加 k
: kDaysInAWeek. 且除去開頭的 k
之外每個單詞開頭字母均大寫。
所有編譯時常量, 無論是區域性的, 全域性的還是類中的, 和其他變數稍微區別一下. k
後接大寫字母開頭的單詞:
const int kDaysInAWeek = 7;
這規則適用於編譯時的區域性作用域常量,不過要按變數規則來命名也可以。
6.6. 函式命名
常規函式使用大小寫混合, 取值和設值函式則要求與變數名匹配: MyExcitingFunction()
, MyExcitingMethod()
, my_exciting_member_variable()
, set_my_exciting_member_variable()
.
常規函式:
函式名的每個單詞首字母大寫, 沒有下劃線。
如果您的某函式出錯時就要直接 crash, 那麼就在函式名加上 OrDie. 但這函式本身必須整合在產品程式碼裡,且平時也可能會出錯。
AddTableEntry() DeleteUrl() OpenFileOrDie()
取值和設值函式:
取值(Accessors)和設值(Mutators)函式要與存取的變數名匹配. 這兒摘錄一個類, num_entries_
是該類的例項變數:
class MyClass { public: ... int num_entries() const { return num_entries_; } void set_num_entries(int num_entries) { num_entries_ = num_entries; } private: int num_entries_; };
其它非常短小的行內函數名也可以用小寫字母, 例如. 如果你在迴圈中呼叫這樣的函式甚至都不用快取其返回值, 小寫命名就可以接受.
6.7. 名字空間命名
名字空間用小寫字母命名, 並基於專案名稱和目錄結構: google_awesome_project
.
關於名字空間的討論和如何命名, 參考 一節.
6.8. 列舉命名
列舉的命名應當和 常量 或 宏 一致: kEnumName
或是 ENUM_NAME
.
單獨的列舉值應該優先採用 常量 的命名方式. 但 宏 方式的命名也可以接受. 列舉名 UrlTableErrors
(以及 AlternateUrlTableErrors
) 是型別, 所以要用大小寫混合的方式.
enum UrlTableErrors { kOK = 0, kErrorOutOfMemory, kErrorMalformedInput, };enum AlternateUrlTableErrors { OK = 0, OUT_OF_MEMORY = 1, MALFORMED_INPUT = 2, };
2009 年 1 月之前, 我們一直建議採用 宏 的方式命名列舉值. 由於列舉值和宏之間的命名衝突, 直接導致了很多問題. 由此, 這裡改為優先選擇常量風格的命名方式. 新程式碼應該儘可能優先使用常量風格. 但是老程式碼沒必要切換到常量風格, 除非宏風格確實會產生編譯期問題.
6.9. 宏命名
你並不打算 使用宏, 對吧? 如果你一定要用, 像這樣命名: MY_MACRO_THAT_SCARES_SMALL_CHILDREN
.
參考 預處理宏; 通常 不應該 使用宏. 如果不得不用, 其命名像列舉命名一樣全部大寫, 使用下劃線:
#define ROUND(x) ...#define PI_ROUNDED 3.0
6.10. 命名規則的特例
如果你命名的實體與已有 C/C++ 實體相似, 可參考現有命名策略.
bigopen()
:
函式名, 參照
open()
的形式
uint
:
typedef
bigpos
:
struct
或class
, 參照pos
的形式
sparse_hash_map
:
STL 相似實體; 參照 STL 命名約定
LONGLONG_MAX
:
常量, 如同
INT_MAX
譯者(acgtyrant)筆記
感覺 Google 的命名約定很高明,比如寫了簡單的類 QueryResult, 接著又可以直接定義一個變數 query_result, 區分度很好;再次,類內變數以下劃線結尾,那麼就可以直接傳入同名的形參,比如 TextQuery::TextQuery(std::string word) : word_(word) {}
, 其中 word_
自然是類內私有成員。
來自 “ ITPUB部落格 ” ,連結:http://blog.itpub.net/3244/viewspace-2809220/,如需轉載,請註明出處,否則將追究法律責任。
相關文章
- Google JavaScript 程式碼風格指南GoJavaScript
- Google JavaScript 風格指南GoJavaScript
- java程式設計規約----程式碼風格(一)Java程式設計
- 高質量C/C++程式設計指南總結(三)—— 命名規則C++程式設計
- CSharp命名風格CSharp
- 《Google 開源專案風格指南》中文版Go
- Java程式設計指南:高階技巧解析 - Excel單元格樣式的程式設計設定Java程式設計Excel
- Vue 前端程式碼風格指南Vue前端
- Google自動程式設計框架AutoML入門指南Go程式設計框架TOML
- 各種流行的程式設計風格程式設計
- 統一規範化程式碼的命名風格
- 高效的css命名約定CSS
- UI培訓教程分享:UI設計如何確定設計風格UI
- Spring MVC 中使用 RESTFul 程式設計風格SpringMVCREST程式設計
- 如何培養良好的程式設計風格程式設計
- Json風格指南JSON
- 前端程式碼規範 — JavaScript 風格指南前端JavaScript
- 開源 react + koa + mysql 設計的簡約風格的個人部落格ReactMySql
- PEP 8 程式程式碼的編寫風格指南
- Laravel - API 的最佳命名約定LaravelAPI
- [譯] Google JavaScript 風格指南中 13 個值得注意的細節GoJavaScript
- 【程式設計素質】Java編碼約定程式設計Java
- 【Swing】UI外觀風格設定UI
- 高質量C++/C程式設計指南(林銳)C++C程式程式設計
- 程式碼重構:檔案相關變數命名約定變數
- 「Adobe國際認證」想要設計!搞懂風格指南,就是你最好的入門設計
- 深圳scala-meetup-20180902(1)- Monadic 程式設計風格程式設計
- rest-api設計風格RESTAPI
- Go 語言程式碼風格規範-指南篇Go
- 程式設計命名規範(網文)程式設計
- JavaScript編碼風格指南JavaScript
- RayWenderlich 官方 Swift 風格指南Swift
- JavaScript 編碼風格指南JavaScript
- 前端工程程式碼規範(一)——命名規則與工程約定前端
- 5.Go變數 常量 變數命名規則 程式碼風格Go變數
- 高質量C/C++程式設計指南總結(八)—— C++高階特性C++程式設計
- Google命名規範Go
- 編寫可維護的JavaScript-程式設計風格JavaScript程式設計