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`` 已弃用。

6.3. 类型命名

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

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

// enums
enum UrlTableErrors { ...

6.4. 变量命名

string table_name;  // 可 - 用下划线。
string tablename;   // 可 - 全小写。

string tableName;   // 差 - 混合大小写。

class TableInfo {
  ...
 private:
  string table_name_;  // 可 - 尾后加下划线。
  string tablename_;   // 可。
  static Pool<TableInfo>* pool_;  // 可。
};

struct UrlTableProperties {
    string name;
    int num_entries;
}

对全局变量没有特别要求, 少用就好, 但如果你要用, 可以用 g_ 或其它标志作为前缀, 以便更好的区分局部变量.

6.5. 常量命名

const int kDaysInAWeek = 7;

6.6. 函数命名

AddTableEntry()
DeleteUrl()
OpenFileOrDie()

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. 名字空间命名

6.8. 枚举命名

enum UrlTableErrors {
    kOK = 0,
    kErrorOutOfMemory,
    kErrorMalformedInput,
};
enum AlternateUrlTableErrors {
    OK = 0,
    OUT_OF_MEMORY = 1,
    MALFORMED_INPUT = 2,
};

6.9. 宏命名

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

6.10. 命名规则的特例

函数名, 参照 open() 的形式

typedef

struct 或 class, 参照 pos 的形式

STL 相似实体; 参照 STL 命名约定

常量, 如同 INT_MAX

译者（acgtyrant）笔记

原文始发于微信公众号（汇编语言）：Google C++ 编程风格指南(六)：命名约定