【6】C++命名约定

参考文献：http://zh-google-styleguide.readthedocs.io/en/latest/google-cpp-styleguide/contents/

 

6.1  通用命名规则

使用描述性词语命名、且写词语全称。

int price_count_reader;

6.2  文件命名

文件名全小写，且尽量使用“_”下划线连接字符。

http_server_logs.h

6.3  类型命名

所有类型名（类class、结构体struct、类型定义 typedef、枚举enum）的每个单词首字母均大写，不包含下划线。

class UrlTable{ ...

struct UrlTableProperties {...

typedef hash_map<UrlTableProperties*, string>  PropertiesMap;

enum UrlTableErrors{ ...

6.4  变量命名

（1）变量名全小写，使用“_”下划线连接；

（2）类的所有成员变量以“_”下划线结尾，但结构体不需要下划线；

（3）全局变量尽量少使用，需要“g_”作为前缀。

string table_name;

class TableInfo{

private:

        string table_name_;

};

struct UrlTableProperties{

        int num_entries;

}

int g_keyboard_value;

6.5  常量命名

常量名前加“k”，且其余单词首字母均大写。

const int kDaysInAWeek =7;

6.6  函数命名

函数名的每个单词首字母均大写，且没有下划线。

但，取值和 设值 函数要与存取的变量名相一致。

AddTableEntry();

class MyClass{

public:

       int get_num() const { return num_;}

       void set_num(int num) { num_ = num; }

private:

       int num_;

};

6.7.名字空间命名

名字空间用小写字母命名，“_”下划线隔开，并基于项目名称和目录结构。

6.8.枚举命名

枚举名优先采用常量 命名，其次是 宏 。

enum UrlTableErrors{

       kOK= 0,

       kErrorOutOfMemory= 1,

};

enumAlternateUrlTableErrors {

       OUT_OF_MEMORY= 1,

       MALFORMED_INPUT= 2,

};

6.9.宏命名

通常不应该使用宏，如使用则全大写，单词间下划线隔开。

#define PI_ROUNDED 3.0

6.10.命名规则的特例

如果你命名的实体与已有 C/C++ 实体相似,可参考现有命名策略。