游戲人生

原文地址：Google C++ Style Guide

• Google特有的風情

Google有很多自己實現的使C++代碼更加健壯的技巧、功能，以及有異于別處的C++的使用方式。

1. 智能指針（Smart Pointers）

如果確實需要使用智能指針的話，scoped_ptr完全可以勝任。在非常特殊的情況下，例如對STL容器中對象，你應該只使用std::tr1::shared_ptr，任何情況下都不要使用auto_ptr。

“智能”指針看上去是指針，其實是附加了語義的對象。以scoped_ptr為例，scoped_ptr被銷毀時，刪除了它所指向的對象。shared_ptr也是如此，而且，shared_ptr實現了引用計數（reference-counting），從而只有當它所指向的最后一個對象被銷毀時，指針才會被刪除。

一般來說，我們傾向于設計對象隸屬明確的代碼，最明確的對象隸屬是根本不使用指針，直接將對象作為一個域（field）或局部變量使用。另一種極端是引用計數指針不屬于任何對象，這樣設計的問題是容易導致循環引用或其他導致對象無法刪除的詭異條件，而且在每一次拷貝或賦值時連原子操作都會很慢。

雖然不推薦這么做，但有些時候，引用計數指針是最簡單有效的解決方案。

譯者注：看來，Google所謂的不同之處，在于盡量避免使用智能指針:D，使用時也盡量局部化，并且，安全第一。

• 其他C++特性

1. 引用參數（Reference Arguments）

所以按引用傳遞的參數必須加上const。

定義：在C語言中，如果函數需要修改變量的值，形參（parameter）必須為指針，如int foo(int *pval)。在C++中，函數還可以聲明引用形參：int foo(int &val)。

優點：定義形參為引用避免了像(*pval)++這樣丑陋的代碼，像拷貝構造函數這樣的應用也是必需的，而且不像指針那樣不接受空指針NULL。

缺點：容易引起誤解，因為引用在語法上是值卻擁有指針的語義。

結論：

函數形參表中，所有引用必須是const：

事實上這是一個硬性約定：輸入參數為值或常數引用，輸出參數為指針；輸入參數可以是常數指針，但不能使用非常數引用形參。

在強調參數不是拷貝而來，在對象生命期內必須一直存在時可以使用常數指針，最好將這些在注釋中詳細說明。bind2nd和mem_fun等STL適配器不接受引用形參，這種情況下也必須以指針形參聲明函數。

2. 函數重載（Function Overloading）

僅在輸入參數類型不同、功能相同時使用重載函數（含構造函數），不要使用函數重載模仿缺省函數參數。

定義：可以定義一個函數參數類型為const string&，并定義其重載函數類型為const char*。

優點：通過重載不同參數的同名函數，令代碼更加直觀，模板化代碼需要重載，同時為訪問者帶來便利。

缺點：限制使用重載的一個原因是在特定調用處很難確定到底調用的是哪個函數，另一個原因是當派生類只重載函數的部分變量會令很多人對繼承語義產生困惑。此外在閱讀庫的客戶端代碼時，因缺省函數參數造成不必要的費解。

結論：如果你想重載一個函數，考慮讓函數名包含參數信息，例如，使用AppendString()、AppendInt()而不是Append()。

3. 缺省參數（Default Arguments）

禁止使用缺省函數參數。

優點：經常用到一個函數帶有大量缺省值，偶爾會重寫一下這些值，缺省參數為很少涉及的例外情況提供了少定義一些函數的方便。

缺點：大家經常會通過查看現有代碼確定如何使用API，缺省參數使得復制粘貼以前的代碼難以呈現所有參數，當缺省參數不適用于新代碼時可能導致重大問題。

結論：所有參數必須明確指定，強制程序員考慮API和傳入的各參數值，避免使用可能不為程序員所知的缺省參數。

4. 變長數組和alloca（Variable-Length Arrays and alloca()）

禁止使用變長數組和alloca()。

優點：變長數組具有渾然天成的語法，變長數組和alloca()也都很高效。

缺點：變長數組和alloca()不是標準C++的組成部分，更重要的是，它們在堆棧（stack）上根據數據分配大小可能導致難以發現的內存泄漏：“在我的機器上運行的好好的，到了產品中卻莫名其妙的掛掉了”。

結論：

使用安全的分配器（allocator），如scoped_ptr/scoped_array。

5. 友元（Friends）

允許合理使用友元類及友元函數。

通常將友元定義在同一文件下，避免讀者跑到其他文件中查找其對某個類私有成員的使用。經常用到友元的一個地方是將FooBuilder聲明為Foo的友元，FooBuilder以便可以正確構造Foo的內部狀態，而無需將該狀態暴露出來。某些情況下，將一個單元測試用類聲明為待測類的友元會很方便。

友元延伸了（但沒有打破）類的封裝界線，當你希望只允許另一個類訪問某個成員時，使用友元通常比將其聲明為public要好得多。當然，大多數類應該只提供公共成員與其交互。

6. 異常（Exceptions）

不要使用C++異常。

優點：

1) 異常允許上層應用決定如何處理在底層嵌套函數中發生的“不可能發生”的失敗，不像出錯代碼的記錄那么模糊費解；

2) 應用于其他很多現代語言中，引入異常使得C++與Python、Java及其他與C++相近的語言更加兼容；

3) 許多C++第三方庫使用異常，關閉異常將導致難以與之結合；

4) 異常是解決構造函數失敗的唯一方案，雖然可以通過工廠函數（factory function）或Init()方法模擬異常，但他們分別需要堆分配或新的“非法”狀態；

5) 在測試框架（testing framework）中，異常確實很好用。

缺點：

1) 在現有函數中添加throw語句時，必須檢查所有調用處，即使它們至少具有基本的異常安全保護，或者程序正常結束，永遠不可能捕獲該異常。例如：if f() calls g() calls h()，h拋出被f捕獲的異常，g就要當心了，避免沒有完全清理；

2) 通俗一點說，異常會導致程序控制流（control flow）通過查看代碼無法確定：函數有可能在不確定的地方返回，從而導致代碼管理和調試困難，當然，你可以通過規定何時何地如何使用異常來最小化的降低開銷，卻給開發人員帶來掌握這些規定的負擔；

3) 異常安全需要RAII和不同編碼實踐。輕松、正確編寫異常安全代碼需要大量支撐。允許使用異常；

4) 加入異常使二進制執行代碼體積變大，增加了編譯時長（或許影響不大），還可能增加地址空間壓力；

5) 異常的實用性可能會刺激開發人員在不恰當的時候拋出異常，或者在不安全的地方從異常中恢復，例如，非法用戶輸入可能導致拋出異常。如果允許使用異常會使得這樣一篇編程風格指南長出很多（譯者注，這個理由有點牽強:-(）！

結論：

從表面上看，使用異常利大于弊，尤其是在新項目中，然而，對于現有代碼，引入異常會牽連到所有依賴代碼。如果允許異常在新項目中使用，在跟以前沒有使用異常的代碼整合時也是一個麻煩。因為Google現有的大多數C++代碼都沒有異常處理，引入帶有異常處理的新代碼相當困難。

鑒于Google現有代碼不接受異常，在現有代碼中使用異常比在新項目中使用的代價多少要大一點，遷移過程會比較慢，也容易出錯。我們也不相信異常的有效替代方案，如錯誤代碼、斷言等，都是嚴重負擔。

我們并不是基于哲學或道德層面反對使用異常，而是在實踐的基礎上。因為我們希望使用Google上的開源項目，但項目中使用異常會為此帶來不便，因為我們也建議不要在Google上的開源項目中使用異常，如果我們需要把這些項目推倒重來顯然不太現實。

對于Windows代碼來說，這一點有個例外（等到最后一篇吧:D）。

譯者注：對于異常處理，顯然不是短短幾句話能夠說清楚的，以構造函數為例，很多C++書籍上都提到當構造失敗時只有異常可以處理，Google禁止使用異常這一點，僅僅是為了自身的方便，說大了，無非是基于軟件管理成本上，實際使用中還是自己決定。

7. 運行時類型識別（Run-Time Type Information, RTTI）

我們禁止使用RTTI。

定義：RTTI允許程序員在運行時識別C++類對象的類型。

優點：

RTTI在某些單元測試中非常有用，如在進行工廠類測試時用于檢驗一個新建對象是否為期望的動態類型。

除測試外，極少用到。

缺點：運行時識別類型意味著設計本身有問題，如果你需要在運行期間確定一個對象的類型，這通常說明你需要重新考慮你的類的設計。

結論：

除單元測試外，不要使用RTTI，如果你發現需要所寫代碼因對象類型不同而動作各異的話，考慮換一種方式識別對象類型。

虛函數可以實現隨子類類型不同而執行不同代碼，工作都是交給對象本身去完成。

如果工作在對象之外的代碼中完成，考慮雙重分發方案，如Visitor模式，可以方便的在對象本身之外確定類的類型。

如果你認為上面的方法你掌握不了，可以使用RTTI，但務必請三思，不要去手工實現一個貌似RTTI的方案（RTTI-like workaround），我們反對使用RTTI，同樣反對貼上類型標簽的貌似類繼承的替代方案（譯者注，使用就使用吧，不使用也不要造輪子:D）。

8. 類型轉換（Casting）

使用static_cast<>()等C++的類型轉換，不要使用int y = (int)x或int y = int(x);。

定義：C++引入了有別于C的不同類型的類型轉換操作。

優點：C語言的類型轉換問題在于操作比較含糊：有時是在做強制轉換（如(int)3.5），有時是在做類型轉換（如(int)"hello"）。另外，C++的類型轉換查找更容易、更醒目。

缺點：語法比較惡心（nasty）。

結論：使用C++風格而不要使用C風格類型轉換。

1) static_cast：和C風格轉換相似可做值的強制轉換，或指針的父類到子類的明確的向上轉換；

2) const_cast：移除const屬性；

3) reinterpret_cast：指針類型和整型或其他指針間不安全的相互轉換，僅在你對所做一切了然于心時使用；

4) dynamic_cast：除測試外不要使用，除單元測試外，如果你需要在運行時確定類型信息，說明設計有缺陷（參考RTTI）。

9. 流（Streams）

只在記錄日志時使用流。

定義：流是printf()和scanf()的替代。

優點：有了流，在輸出時不需要關心對象的類型，不用擔心格式化字符串與參數列表不匹配（雖然在gcc中使用printf也不存在這個問題），打開、關閉對應文件時，流可以自動構造、析構。

缺點：流使得pread()等功能函數很難執行，如果不使用printf之類的函數而是使用流很難對格式進行操作（尤其是常用的格式字符串%.*s），流不支持字符串操作符重新定序（%1s），而這一點對國際化很有用。

結論：

不要使用流，除非是日志接口需要，使用printf之類的代替。

使用流還有很多利弊，代碼一致性勝過一切，不要在代碼中使用流。

拓展討論：

對這一條規則存在一些爭論，這兒給出深層次原因。回憶唯一性原則（Only One Way）：我們希望在任何時候都只使用一種確定的I/O類型，使代碼在所有I/O處保持一致。因此，我們不希望用戶來決定是使用流還是printf + read/write，我們應該決定到底用哪一種方式。把日志作為例外是因為流非常適合這么做，也有一定的歷史原因。

流的支持者們主張流是不二之選，但觀點并不是那么清晰有力，他們所指出流的所有優勢也正是其劣勢所在。流最大的優勢是在輸出時不需要關心輸出對象的類型，這是一個亮點，也是一個不足：很容易用錯類型，而編譯器不會報警。使用流時容易造成的一類錯誤是：

cout << this;  // Prints the address
cout << *this;  // Prints the contents

編譯器不會報錯，因為<<被重載，就因為這一點我們反對使用操作符重載。

有人說printf的格式化丑陋不堪、易讀性差，但流也好不到哪兒去。看看下面兩段代碼吧，哪個更加易讀？

cerr << "Error connecting to '" << foo->bar()->hostname.first
     << ":" << foo->bar()->hostname.second << ": " << strerror(errno);

fprintf(stderr, "Error connecting to '%s:%u: %s",
        foo->bar()->hostname.first, foo->bar()->hostname.second,
        strerror(errno));

你可能會說，“把流封裝一下就會比較好了”，這兒可以，其他地方呢？而且不要忘了，我們的目標是使語言盡可能小，而不是添加一些別人需要學習的新的內容。

每一種方式都是各有利弊，“沒有最好，只有更好”，簡單化的教條告誡我們必須從中選擇其一，最后的多數決定是printf + read/write。

10. 前置自增和自減（Preincrement and Predecrement）

對于迭代器和其他模板對象使用前綴形式（++i）的自增、自減運算符。

定義：對于變量在自增（++i或i++）或自減（--i或i--）后表達式的值又沒有沒用到的情況下，需要確定到底是使用前置還是后置的自增自減。

優點：不考慮返回值的話，前置自增（++i）通常要比后置自增（i++）效率更高，因為后置的自增自減需要對表達式的值i進行一次拷貝，如果i是迭代器或其他非數值類型，拷貝的代價是比較大的。既然兩種自增方式動作一樣（譯者注，不考慮表達式的值，相信你知道我在說什么），為什么不直接使用前置自增呢？

缺點：C語言中，當表達式的值沒有使用時，傳統的做法是使用后置自增，特別是在for循環中，有些人覺得后置自增更加易懂，因為這很像自然語言，主語（i）在謂語動詞（++）前。

結論：對簡單數值（非對象）來說，兩種都無所謂，對迭代器和模板類型來說，要使用前置自增（自減）。

11. const的使用（Use of const）

我們強烈建議你在任何可以使用的情況下都要使用const。

定義：在聲明的變量或參數前加上關鍵字const用于指明變量值不可修改（如const int foo），為類中的函數加上const限定表明該函數不會修改類成員變量的狀態（如class Foo { int Bar(char c) const; };）。

優點：人們更容易理解變量是如何使用的，編輯器可以更好地進行類型檢測、更好地生成代碼。人們對編寫正確的代碼更加自信，因為他們知道所調用的函數被限定了能或不能修改變量值。即使是在無鎖的多線程編程中，人們也知道什么樣的函數是安全的。

缺點：如果你向一個函數傳入const變量，函數原型中也必須是const的（否則變量需要const_cast類型轉換），在調用庫函數時這尤其是個麻煩。

結論：const變量、數據成員、函數和參數為編譯時類型檢測增加了一層保障，更好的盡早發現錯誤。因此，我們強烈建議在任何可以使用的情況下使用const：

1) 如果函數不會修改傳入的引用或指針類型的參數，這樣的參數應該為const；

2) 盡可能將函數聲明為const，訪問函數應該總是const，其他函數如果不會修改任何數據成員也應該是const，不要調用非const函數，不要返回對數據成員的非const指針或引用；

3) 如果數據成員在對象構造之后不再改變，可將其定義為const。

然而，也不要對const過度使用，像const int * const * const x;就有些過了，即便這樣寫精確描述了x，其實寫成const int** x就可以了。

關鍵字mutable可以使用，但是在多線程中是不安全的，使用時首先要考慮線程安全。

const位置：

有人喜歡int const *foo形式不喜歡const int* foo，他們認為前者更加一致因此可讀性更好：遵循了const總位于其描述的對象（int）之后的原則。但是，一致性原則不適用于此，“不要過度使用”的權威抵消了一致性使用。將const放在前面才更易讀，因為在自然語言中形容詞（const）是在名詞（int）之前的。

這是說，我們提倡const在前，并不是要求，但要兼顧代碼的一致性！

12. 整型（Integer Types）

C++內建整型中，唯一用到的是int，如果程序中需要不同大小的變量，可以使用<stdint.h>中的精確寬度（precise-width）的整型，如int16_t。

定義：C++沒有指定整型的大小，通常人們認為short是16位，int是32位，long是32位，long long是64位。

優點：保持聲明統一。

缺點：C++中整型大小因編譯器和體系結構的不同而不同。

結論：

<stdint.h>定義了int16_t、uint32_t、int64_t等整型，在需要確定大小的整型時可以使用它們代替short、unsigned long long等，在C整型中，只使用int。適當情況下，推薦使用標準類型如size_t和ptrdiff_t。

最常使用的是，對整數來說，通常不會用到太大，如循環計數等，可以使用普通的int。你可以認為int至少為32位，但不要認為它會多于32位，需要64位整型的話，可以使用int64_t或uint64_t。

對于大整數，使用int64_t。

不要使用uint32_t等無符號整型，除非你是在表示一個位組（bit pattern）而不是一個數值。即使數值不會為負值也不要使用無符號類型，使用斷言（assertion，譯者注，這一點很有道理，計算機只會根據變量、返回值等有無符號確定數值正負，仍然無法確定對錯）來保護數據。

無符號整型：

有些人，包括一些教科書作者，推薦使用無符號類型表示非負數，類型表明了數值取值形式。但是，在C語言中，這一優點被由其導致的bugs所淹沒。看看：

for (unsigned int i = foo.Length()-1; i >= 0; --i) ...

上述代碼永遠不會終止！有時gcc會發現該bug并報警，但通常不會。類似的bug還會出現在比較有符合變量和無符號變量時，主要是C的類型提升機制（type-promotion scheme，C語言中各種內建類型之間的提升轉換關系）會致使無符號類型的行為出乎你的意料。

因此，使用斷言聲明變量為非負數，不要使用無符號型。

13. 64位下的可移植性（64-bit Portability）

代碼在64位和32位的系統中，原則上應該都比較友好，尤其對于輸出、比較、結構對齊（structure alignment）來說：

1) printf()指定的一些類型在32位和64位系統上可移植性不是很好，C99標準定義了一些可移植的格式。不幸的是，MSVC 7.1并非全部支持，而且標準中也有所遺漏。所以有時我們就不得不自己定義丑陋的版本（使用標準風格要包含文件inttypes.h）：

// printf macros for size_t, in the style of inttypes.h
#ifdef _LP64
#define __PRIS_PREFIX "z"
#else
#define __PRIS_PREFIX
#endif

// Use these macros after a % in a printf format string
// to get correct 32/64 bit behavior, like this:
// size_t size = records.size();
// printf("%"PRIuS"\n", size);

#define PRIdS __PRIS_PREFIX "d"
#define PRIxS __PRIS_PREFIX "x"
#define PRIuS __PRIS_PREFIX "u"
#define PRIXS __PRIS_PREFIX "X"
#define PRIoS __PRIS_PREFIX "o" 

注意宏PRI*會被編譯器擴展為獨立字符串，因此如果使用非常量的格式化字符串，需要將宏的值而不是宏名插入格式中，在使用宏PRI*時同樣可以在%后指定長度等信息。例如，printf("x = %30"PRIuS"\n", x)在32位Linux上將被擴展為printf("x = %30" "u" "\n", x)，編譯器會處理為printf("x = %30u\n", x)。

2) 記住sizeof(void *) != sizeof(int)，如果需要一個指針大小的整數要使用intptr_t。

3) 需要對結構對齊加以留心，尤其是對于存儲在磁盤上的結構體。在64位系統中，任何擁有int64_t/uint64_t成員的類/結構體將默認被處理為8字節對齊。如果32位和64位代碼共用磁盤上的結構體，需要確保兩種體系結構下的結構體的對齊一致。大多數編譯器提供了調整結構體對齊的方案。gcc中可使用__attribute__((packed))，MSVC提供了#pragma pack()和__declspec(align())（譯者注，解決方案的項目屬性里也可以直接設置）。

4) 創建64位常量時使用LL或ULL作為后綴，如：

int64_t my_value = 0x123456789LL;
uint64_t my_mask = 3ULL << 48;

5) 如果你確實需要32位和64位系統具有不同代碼，可以在代碼變量前使用。（盡量不要這么做，使用時盡量使修改局部化）。

14. 預處理宏（Preprocessor Macros）

使用宏時要謹慎，盡量以內聯函數、枚舉和常量代替之。

宏意味著你和編譯器看到的代碼是不同的，因此可能導致異常行為，尤其是當宏存在于全局作用域中。

值得慶幸的是，C++中，宏不像C中那么必要。宏內聯效率關鍵代碼（performance-critical code）可以內聯函數替代；宏存儲常量可以const變量替代；宏“縮寫”長變量名可以引用替代；使用宏進行條件編譯，這個……，最好不要這么做，會令測試更加痛苦（#define防止頭文件重包含當然是個例外）。

宏可以做一些其他技術無法實現的事情，在一些代碼庫（尤其是底層庫中）可以看到宏的某些特性（如字符串化（stringifying，譯者注，使用#）、連接（concatenation，譯者注，使用##）等等）。但在使用前，仔細考慮一下能不能不使用宏實現同樣效果。

譯者注：關于宏的高級應用，可以參考C語言宏的高級應用。

下面給出的用法模式可以避免一些使用宏的問題，供使用宏時參考：

1) 不要在.h文件中定義宏；

2) 使用前正確#define，使用后正確#undef；

3) 不要只是對已經存在的宏使用#undef，選擇一個不會沖突的名稱；

4) 不使用會導致不穩定的C++構造（unbalanced C++ constructs，譯者注）的宏，至少文檔說明其行為。

15. 0和NULL（0 and NULL）

整數用0，實數用0.0，指針用NULL，字符（串）用'\0'。

整數用0，實數用0.0，這一點是毫無爭議的。

對于指針（地址值），到底是用0還是NULL，Bjarne Stroustrup建議使用最原始的0，我們建議使用看上去像是指針的NULL，事實上一些C++編譯器（如gcc 4.1.0）專門提供了NULL的定義，可以給出有用的警告，尤其是sizeof(NULL)和sizeof(0)不相等的情況。

字符（串）用'\0'，不僅類型正確而且可讀性好。

16. sizeof（sizeof）

盡可能用sizeof(varname)代替sizeof(type)。

使用sizeof(varname)是因為當變量類型改變時代碼自動同步，有些情況下sizeof(type)或許有意義，還是要盡量避免，如果變量類型改變的話不能同步。

Struct data;
memset(&data, 0, sizeof(data));

memset(&data, 0, sizeof(Struct));

17. Boost庫（Boost）

只使用Boost中被認可的庫。

定義：Boost庫集是一個非常受歡迎的、同級評議的（peer-reviewed）、免費的、開源的C++庫。

優點：Boost代碼質量普遍較高、可移植性好，填補了C++標準庫很多空白，如型別特性（type traits）、更完善的綁定（binders）、更好的智能指針，同時還提供了TR1（標準庫的擴展）的實現。

缺點：某些Boost庫提倡的編程實踐可讀性差，像元程序（metaprogramming）和其他高級模板技術，以及過度“函數化”（"functional"）的編程風格。

結論：為了向閱讀和維護代碼的人員提供更好的可讀性，我們只允許使用Boost特性的一個成熟子集，當前，這些庫包括：

1) Compressed Pair：boost/compressed_pair.hpp；

2) Pointer Container：boost/ptr_container不包括ptr_array.hpp和序列化（serialization）。

我們會積極考慮添加可以的Boost特性，所以不必拘泥于該規則。

______________________________________

譯者：關于C++特性的注意事項，總結一下：

1. 對于智能指針，安全第一、方便第二，盡可能局部化（scoped_ptr）；

2. 引用形參加上const，否則使用指針形參；

3. 函數重載的使用要清晰、易讀；

4. 鑒于容易誤用，禁止使用缺省函數參數（值得商榷）；

5. 禁止使用變長數組；

6. 合理使用友元；

7. 為了方便代碼管理，禁止使用異常（值得商榷）；

8. 禁止使用RTTI，否則重新設計代碼吧；

9. 使用C++風格的類型轉換，除單元測試外不要使用dynamic_cast；

10. 使用流還printf + read/write，it is a problem；

11. 能用前置自增/減不用后置自增/減；

12. const能用則用，提倡const在前；

13. 使用確定大小的整型，除位組外不要使用無符號型；

14. 格式化輸出及結構對齊時，注意32位和64位的系統差異；

15. 除字符串化、連接外盡量避免使用宏；

16. 整數用0，實數用0.0，指針用NULL，字符（串）用'\0'；

17. 用sizeof(varname)代替sizeof(type)；

18. 只使用Boost中被認可的庫。