為了形成個人的編碼風格而簡單編寫的規范,比較簡陋,之后會再慢慢對細節進行補充。
關於排版、注釋、程序可讀性和變量、函數、類的使用等的規范會繼續編寫,最后整理成完整的代碼規范。
公用准則
- 只能是字母(A-Z,a-z)和數字(0-9)或者下划線(_)組成,區分大小寫。
- 文件、函數、變量命名應具有描述性;
- 類、自定義類型和變量命名應使用名詞,函數名使用名詞或動、名詞結合的方式命名。
- 除非表意十分清晰,否則不使用縮寫。
- 不加類型前綴,只保留全局變量、類成員變量和常量前綴。
文件命名
文件名全部使用小寫,單詞間以下划線( _ )間隔。如:a_file.cpp。
C++文件以.cpp結尾,頭文件以.h結尾。
類或模塊定義時文件名一般一一對應,如file.cpp和file.h。
類型命名
類、結構體、自定義類型和枚舉類型均使用相同原則:每個單詞都以大寫字母開頭,不包含下划線。
宏和枚舉命名
盡量不使用宏。
宏和枚舉值均全部大寫,單詞間用下划線( _ )間隔。如:MAX_VALUE。
函數命名
函數名每個單詞都以大寫字母開頭,不包含下划線。
動詞、名詞結合,指明函數用途。如:GetNames()。
變量命名
變量名除第一個單詞外,其他單詞首字母大寫。
類成員變量加前綴m_ ,全局變量加前綴g_,結構體成員變量與普通變量相同。
特殊:i、j、k作為循環變量,tmp作為臨時變量。
常量命名
加前綴k,並且每個單詞首字母大寫。如:kMaxValue。
