c++-编程规范

一、文件命名

文件名要全部小写,可以包含下划线(_)或短线(-)。

1
2
3
my_useful_class.cc
my-useful-class.cc
myusefulclass.cc

二、类型命令

类型命名每个单词以大写字母开头,不包含下划线:MyExcitingClass、 MyExcitingEnum。 所有类型命名——类、结构体、类型定义(typedef)、枚举——使用相同约定,例如:

1
2
3
4
5
6
7
8
// classes and structs
class UrlTable { ...
class UrlTableTester { ...
struct UrlTableProperties { ...
// typedefs
typedef hash_map<UrlTableProperties *, string> PropertiesMap;
// enums
enum UrlTableErrors { ...

三、变量命名

变量名一律小写,单词间以下划线相连。

3.1. 普通变量命名

string table_name;

3.2. 类数据成员命名,以下划线结尾

string name_;

3.3. 结构体数据成员命名,可以和普通成员一样,不用像类那样接下划线结尾:

1
2
3
4
struct UrlTableProperties {
string name;
int num_entries;
}

3.4. 全局变量命名,以g_为前缀

string g_name;

3.5. 常量命名,k后接大写字母开头的单词

const int kDaysInAWeek = 7;

四、函数命名

4.1. 普通函数,函数名以大写字母开头,每个单词首字母大写

1
2
int AddTableEntry()
bool DeleteUrl()

4.2. 存取函数,要与存取的变量名相匹配

1
2
3
4
5
6
7
8
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_;
};

五、命名空间

命名空间的名称是全小写的,其命名基于项目名称和目录结构:google_awesome_project

六、枚举命名

枚举值全部大写,单词间以下划线相连;枚举名称属于类型,因此大写混合:

1
2
3
4
5
enum UrlTableErrors {
OK = 0,
ERROR_OUT_OF_MEMORY,
ERROR_MALFORMED_INPUT,
};
  • 版权声明: 本博客所有文章,未经许可,任何单位及个人不得做营利性使用!转载请标明出处!如有侵权请联系作者。
  • Copyrights © 2015-2020 翟天野

请我喝杯咖啡吧~