C++语言编程规范-风格

01

11.1 标示符命名与定义

建议 11.1 类命名以大写字母开头，中间单词也以大写开头

示例：

class UrlTable;

class UrlTableProperties;

02

11.2 排版

建议 11.2 类的声明按照一定的次序进行，关键字不缩进

说明：类的声明按照一定的次序和规范进行。建议的次序如下：

⚫ 按照存取控制特性段排序：public、protected、private，如果没有可以忽略。这个排序是让声明的时候使用者首先看到最关心的特性(对外接口)。

⚫ 在每一段中按照如下顺序声明(先定义后续用到的类型，常量和 enums；然后定义行为(构造，析构，成员函数)，最后定义成员变量):

1. typedefs和enums；

2. 常量；

3. 构造函数；

4. 析构函数；

5. 成员函数，含静态成员函数；

6. 数据成员，含静态数据成员。

03

建议 11.3 构造函数初始化列表在同一行或按 4 格缩进并排几行

示例：初始化列表放在同一行：

class TaskProgressTimer  {  public:  TaskProgressTimer(CHRCollectTask & parent):m_delayTime(30)  { }  }；

初始化列表并排多行：

class TaskProgressTimer  {  public:  TaskProgressTimer(CHRCollectTask & parent):  m_parTask(parent) ,  m_delayTime(30) ,m_intervalTime(50) ,  timer_handler_( reactor(), *this, m_delayTime, m_intervalTime )  {  }

04

11.3 注释

建议 11.4 使用'//'注释方式，而不是'/* */'

说明：说明：使用 '//' 而不是 '/* */' 来注释 C++代码。使用'/* */'的缺点就是容易产生交叉错乱。

即使注释多行代码，//仍然是首选，现在的编辑器提供多行加'//'和去'//'的功能。

建议 11.5 为重要的类或结构体作注释，注释格式支持工具自动生成

说明：为重要的类或结构体作注释，不宜写太多无用的注释。注释主要表达代码难以直接表达的意思。

建议 11.6 为所有重要的成员函数作注释

建议 11.7 正式发布的代码不能使用 TODO 注释

说明：对那些临时的、短期的解决方案，或待改进的代码使用 TODO 注释。使用全大写的字符串 TODO，后面

括号里加上姓名、工号等信息。

//TODO(姓名： 工号： ):注释内容

05

11.4 文件组织

建议 11.8 整个项目需要的公共头文件应放在一个单独的目录下

建议 11.9 一个模块的目录层次不宜太深，以 1～2 层为宜，接口文件放在最外层

建议 11.10 保持文件前言的简洁性

说明：给出版权说明和该文件的简介后即可切入正题------编码。