6 命名約定

最重要的一致性規則是命名管理. 命名風格快速獲知名字代表是什麼東東: 型別? 變數? 函式? 常量? 巨集 ... ? 甚至不需要去查詢型別宣告. 我們大腦中的模式匹配引擎可以非常可靠的處理這些命名規則.

命名規則具有一定隨意性, 但相比按個人喜好命名, 一致性更重, 所以不管你怎麼想, 規則總歸是規則.

tip函式命名, 變數命名, 檔案命名應具備描述性; 不要過度縮寫. 型別和變數應該是名詞, 函式名可以用「命令性」動詞.

如何命名:

盡可能給出描述性的名稱. 不要節約行空間, 讓別人很快理解你的**更重要. 好的命名風格:

int
num_errors
;// good.
intnum_completed_connections
;// good.

糟糕的命名使用含糊的縮寫或隨意的字元:

intn;
// bad - meaningless.
intnerr
;// bad - ambiguous abbreviation.
intn_comp_conns
;// bad - ambiguous abbreviation.

型別和變數名一般為名詞: 如 fileopener

, num_errors

.函式名通常是指令性的 (確切的說它們應該是命令), 如 openfile()

, set_num_errors()

. 取值函式是個特例 (在函式命名

處詳細闡述), 函式名和它要取值的變數同名.

縮寫:

除非該縮寫在其它地方都非常普遍, 否則不要使用. 例如:

// good

// these show proper names with no abbreviations.

intnum_dns_connections

;// 大部分人都知道 "dns" 是啥意思.

intprice_count_reader

;// ok, price count. 有意義.

warning

// bad!

// abbreviations can be confusing or ambiguous outside a small group.

intwgc_connections

;// only your group knows what this stands for.

intpc_reader

;// lots of things can be abbreviated "pc".

永遠不要用省略字母的縮寫:

int
error_count
;// good.
interror_cnt
;// bad.

tip檔名要全部小寫, 可以包含下劃線 (_

) 或連字元 (-

). 按專案約定來.

可接受的檔案命名:

my_useful_class.cc

my-useful-class.cc

myusefulclass.cc

c++ 檔案要以 .cc

結尾, 標頭檔案以 .h

結尾.不要使用已經存在於 /usr/include

下的檔名 (yospaly 注: 即編譯器搜尋系統標頭檔案的路徑), 如 db.h

.通常應盡量讓檔名更加明確. http_server_logs.h

就比 logs.h

要好. 定義類時檔名一般成對出現, 如 foo_bar.h

和 foo_bar.cc

, 對應於類 foobar

.內聯函式必須放在 .h

檔案中. 如果內聯函式比較短, 就直接放在 .h

中. 如果**比較長, 可以放到以 -inl.h

結尾的檔案中. 對於包含大量內聯**的類, 可以使用三個檔案:

url_table.h      // the class declaration.
url_table.cc // the class definition.
url_table-inl.h // inline functions that include lots of code.

參考 -inl.h 檔案

一節.tip

型別名稱的每個單詞首字母均大寫, 不包含下劃線: myexcitingclass

, myexcitingenum.

所有型別命名 —— 類, 結構體, 型別定義 (

typedef

), 列舉 —— 均使用相同約定. 例如:

// classes and structs

class

urltable

結構體與類的討論參考結構體 vs. 類

一節.全域性變數:

對全域性變數沒有特別要求, 少用就好, 但如果你要用, 可以用

g_或其它標誌作為字首, 以便更好的區分區域性變數.

tip在名稱前加 k

: kdaysinaweek.

所有編譯時常量, 無論是區域性的, 全域性的還是類中的, 和其他變數稍微區別一下.

k後接大寫字母開頭的單詞::

const int kdaysinaweek = 7;

tip常規函式使用大小寫混合, 取值和設值函式則要求與變數名匹配: myexcitingfunction()

, myexcitingmethod()

, my_exciting_member_variable()

, set_my_exciting_member_variable().

常規函式:

函式名的每個單詞首字母大寫, 沒有下劃線:

addtableentry
()deleteurl
()

取值和設值函式:

取值和設值函式要與訪問的變數名匹配. 這兒摘錄乙個類,

num_entries_

是該類的例項變數:

class
myclass
void
set_num_entries
(int
num_entries
)private
:int
num_entries_
;};

其它非常短小的內聯函式名也可以用小寫字母, 例如. 如果你在迴圈中呼叫這樣的函式甚至都不用快取其返回值, 小寫命名就可以接受.

tip名字空間用小寫字母命名, 並基於專案名稱和目錄結構: google_awesome_project.

關於名字空間的討論和如何命名, 參考名字空間

一節.tip

列舉的命名應當和常量

或巨集一致: kenumname

或是 enum_name.

單獨的列舉值應該優先採用

常量的命名方式. 但

巨集方式的命名也可以接受. 列舉名

urltableerrors

(以及

alternateurltableerrors

) 是型別, 所以要用大小寫混合的方式.

enum
urltableerrors
;enum
alternateurltableerrors
;

2009 年 1 月之前, 我們一直建議採用巨集

的方式命名列舉值. 由於列舉值和巨集之間的命名衝突, 直接導致了很多問題. 由此, 這裡改為優先選擇常量風格的命名方式. 新**應該盡可能優先使用常量風格. 但是老**沒必要切換到常量風格, 除非巨集風格確實會產生編譯期問題.

tip你並不打算使用巨集

, 對吧? 如果你一定要用, 像這樣命名: my_macro_that_scares_small_children.

參考預處理巨集 ; 通常不應該使用巨集. 如果不得不用, 其命名像列舉命名一樣全部大寫, 使用下劃線:

#define round(x) ...
#define pi_rounded 3.0

tip如果你命名的實體與已有 c/c++ 實體相似, 可參考現有命名策略.

bigopen()

函式名, 參照

open()

的形式

uint

typedef

bigpos

struct

或 class

, 參照

pos的形式

sparse_hash_map

stl 相似實體; 參照 stl 命名約定

longlong_max

常量, 如同

int_max

6 命名約定

Google C 命名約定

C 命名約定

Google C 命名約定

6 命名約定

Google C 命名約定

C 命名約定

Google C 命名約定

相關推薦