C++ 编码规范整理

C++ 编码规范

网上看到一张非常好的代码规范图：

当然也有更细致的规范描述，如下：

目录

1.概述

2.文件排版

2.1.包含头文件

2.2.h和cpp文件

2.3.文件结构

2.4.空行

3.注释方面

3.1.文件头注释

3.2.函数注释

4.命名方面

4.1.原则

4.2.函数

4.3.变量

4.4.类型名

4.5.风格兼容性

5.代码风格

5.1.Tab和空格

5.2.类型定义和{

5.3.代码块

5.4.代码行

5.5.宏

5.6.goto

6.类型

7.表达式

8.函数

8.1.引用

8.2.常成员函数

8.3.返回值

8.4.内联函数

8.5.函数参数

9.类

9.1.构造函数

9.2.纯虚函数

9.3.构造和析构函数

9.4.成员变量

9.5.成员函数

9.6.继承

10.错误处理

11.性能

1.概述

对于高质量的工程，一般会做到：

1. 代码简洁精炼，美观，可读性好，高效率，高复用，可移植性好，高内聚，低耦合，没有冗余，不符合这些原则，必须特别说明。

2. 规范性，代码有规可循。特殊排版、特殊语法、特殊指令，必须特别说明。

===

---

2.文件排版

=============

2.1.包含头文件

• a)系统头文件与用户头文件包含区分开，不交叉。

• b)系统头文件，稳定的目录结构，应采用包含子路径方式。#include”sub/test.h”

• c)系统头文件应用：#include

• d)自定义同文件应用：#include “xxx.h”

• e)只引用需要的头文件。

• f)将所有#include的文件名视为大小写敏感。能使用声明的情况下，使用声明。

2.2. h和cpp文件

• a)头文件命名为*.h，内联文件命名为*.inl；C++文件命名为*.cpp

• b)文件名用不要用无意义的名称：例如XImage.cpp，命名方式在系统中应该统一。

• c)头文件除了特殊情况，应使用#ifdef控制块。

• d)头文件#endif应采用行尾注释。

  <