C++

19-08-26-c++编码规范

C++

Posted by Wangchenchen on 2019-08-26

​ 写了这么长时间重构了n次的惨痛教训下毅然决定总结一套关于c++的编写代码风格,在之前参考了google编程规范中文网站,在这个的基础上整理了一套属于自己的规范风格;

顺便推荐两个宝贝[《匈牙利命名法的辩思》](http://blog.csdn.net/fullsail/article/details/8039253) [Google代码规范工具Cpplint的使用](http://blog.csdn.net/fengbingchun/article/details/47341765)

[TOC]

以下正文

1.文件命名规则:

​ 创建文件,全部小写:内容精简,可以含下划线 如:player.cpp;http_server.cpp,securityreq.cpp,若是类中含大量内联函数可以在末尾加-ini如:

user.h, user.cpp, user-ini.h;

2.头文件布局:

​ 对访问权限位置的规定:从上到下分别是先成员变量在成员函数;变量和函数的权限位置分别是private,protected,public例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
class Student(){
private:
int Id;
protected:
int age;
public:
String name;

private:
int getId();
protected:
int setAge();
public:
String setName();
}

​ 以上关于头文件的分布,下面对里面的变量名,方法名,常量,等详细解释,切记不要出现student1之类的名字,在规范中是不允许的这样,因为会给整段代码的可读性增加难度,编写名字最好要见名知意;

3.类命名规则:

​ 类型命名时每个单词首字母都要大写,不含下划线,以名词形式,如:MyBook,SendMessage,其实不单单是类名,结构体,枚举,等都是这样的;

4.变量命名规范:

​ 变量名一律小写,单词用下划线相连,例如:

​ in student_id; string student_name;

​ 类成员变量以m_开头 如:m_cert;

​ 若类成员变量中的指针类型则以p开头 如:m_pcert;

​ 全局变量则以g_开头,比如:g_cert;

​ 结构体成员变量和类成员变量一样;

5.常量命名规则:

​ k后面跟大写字母开头的单词,比如:

​ const int kMyname = “wangchenchen”

6.函数命名规则:

​ 常规函数使用驼峰命名规则,使用命令式语气,如:openFile(); checkFileName();

​ 对应于存储函数和内联函数使用小写加下划线的方式,如 set_num_errors();

7.名字命名空间:

​ 命名空间全部小写,基于项目名称和项目目录,如:

​ google_anesome_project

8.枚举命名规范:

​ 枚举类名属于类型名,按类命名,枚举值全大写加下划线,比如:ENUM_NAME

9.宏变量命名规则:

​ 如果你一定要用到宏,全大写加下划线,比如:

​ define PI_ROUND 3.0

=============================== End ===============================

e-mail:E-mail:jsntwangchenchen@outlook.com; 王晨晨