Google C++編程風格指南

前言

---

 

　　從小就寫字很挫，所以受夠了被人鄙視的感覺，今天有個coder突然跟我說，你的代碼怎么像小孩寫的一樣，頓時心情沮喪的極點。越來越發現一致的編程風格的重要性，於是把Google的C++編程風格指南看了一遍， 這里記錄下於自己有益的rules。當規則有多個選擇時，這里只記錄個人習慣的用法， 並不代表它是唯一的用法。

---

 

命名約定

命名管理是最重要的一致性規則，因此我把它放在最前面。

• 盡可能給出描述性名稱。

int num_errors; 
int num_completed_connections;

• 文件名全部小寫，用下划線做連接符。

my_useful_class.cc

• C++文件以.cc 結尾，頭文件以.h 結尾。(從.cpp切換到.cc)

my_useful_class.cc
my_useful_class.h

• 類型命名每個單詞以大寫字母開頭，不包含下划線。類、結構體、類型定義(typedef) 、枚舉都使用相同約定。

// classes and structs
class UrlTable { ...
class UrlTableTester { ...
struct UrlTableProperties { ...

// typedefs
typedef hash_map<UrlTableProperties *, string> PropertiesMap;

// enums
enum UrlTableErrors { ...

• 變量名一律小寫，單詞之間用下划線連接。類的成員變量以下划線結尾。

my_exciting_local_variable
my_exciting_member_variable_

• 結構體的數據成員可以和普通變量一樣，不用像類那樣接下划線。

struct UrlTableProperties {
    string name;
    int num_entries;
}

• 少用全局變量，要用的話用g作為其前綴(不喜歡用g_)。

bool gInvalid = false;

• 常量命名在名稱前加k。

const int kDaysInAWeek = 7;

• 函數名的每個單詞首字母大寫，沒有下划線。

AddTableEntry()
DeleteUrl()

• 取值和設值函數要與存取的變量名匹配，使用小寫單詞及下划線。

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_;
};

• 非常短小的內聯函數也可以用小寫字母命名。

void swap(int &a, int &b);
int max(int a, int b);
bool cmp(Type t1, Type t2);

• 名字空間用小寫字母命名，並基於項目名稱和目錄結構：

namespace google_awesome_project {
    ...
}

• 枚舉值應該優先采用常量的命名方式。

enum UrlTableErrors {
    kOK = 0,
    kErrorOutOfMemory,
    kErrorMalformedInput,
};

• 盡量避免使用宏，如果不得不用，請使用大寫字母及下划線。

#define ROUND(x) ...
#define PI_ROUNDED 3.0