当前位置：文档之家 › C++编码规范

C++编码规范

  • 格式：docx
  • 大小：77.19 KB
  • 文档页数：29

C++编码规范

深圳市多赢软件技术有限公司

2009年7月23日

拟 制 人 朱懋柱 拟制日期 2009-7-20

版 本 1.0 审 批 人 张代军 研发体系2.0

密级：保密 研发体系2.0

C++编码规范 1 / 29 版本记录

版本编号 版本日期 修改者 说明

1.0 2009.7.20 朱懋柱 起草

1.0 2009.7.20 谢坚 校对

研发体系2.0

C++编码规范 2 / 29 目录

1.前言 ............................................................................................................................................... 3

2.文件结构........................................................................................................................................ 3

2.1 文件组织 ............................................................................................................................ 3

2.2 版权和版权声明 ................................................................................................................ 4

3 排版风格....................................................................................................................................... 5

3.1 缩进与对齐 ........................................................................................................................ 5

3.2 空行 .................................................................................................................................... 6

3.3 空格 .................................................................................................................................... 8

3.4 风格 .................................................................................................................................. 10

4 命名规范..................................................................................................................................... 11

4.1 一般规范 .......................................................................................................................... 11

4.2 类名 .................................................................................................................................. 11

4.3 接口名 .............................................................................................................................. 12

4.4 函数名 .............................................................................................................................. 12

4.5 变量名 .............................................................................................................................. 12

4.6 结构体名 .......................................................................................................................... 13

4.7 枚举名 .............................................................................................................................. 13

4.8 宏和常量的命名 .............................................................................................................. 13

5 代码设计..................................................................................................................................... 14

5.1 表达式设计 ...................................................................................................................... 14

5.2 条件语句设计 .................................................................................................................. 14

5.3 循环语句设计 .................................................................................................................. 16

5.4 常量设计 .......................................................................................................................... 17

5.5 函数设计 .......................................................................................................................... 18

5.6 内存管理 .......................................................................................................................... 22

5.7 类设计 .............................................................................................................................. 22

6注释规范...................................................................................................................................... 25

6.1 通则 .................................................................................................................................. 25

6.2 代码注释 .......................................................................................................................... 26

7 其他规范..................................................................................................................................... 27

7.1 编译规范 .......................................................................................................................... 27

合集下载

misra c++编号规则

misra c++编号规则

misra c++编号规则

MISRA C++ (MISRA C++:2008) 是一种针对 C++ 编程语言的软件开发规范，旨在提高代码的可读性、可维护性和可靠性。MISRA C++ 包含一系列规则，下面是一些常见的 MISRA C++ 编号规则示例：

1. 规则 2-1-1：禁止使用 C 语言风格的强制类型转换。

2. 规则 3-1-1：不允许使用多个返回语句。

3. 规则 5-0-1：禁止使用 C 语言风格的字符串操作函数。

4. 规则 5-2-2：确保容器类的 size() 函数返回无符号整数类型。

5. 规则 8-0-1：不允许在头文件中定义非内联函数。

6. 规则 14-0-1：确保每个函数都有明确的返回语句。

这些规则是为了遵循良好的编程实践和减少代码的潜在错误，但具体的规则数量和内容可能因不同版本的 MISRA C++ 规范而有所不同。在实际开发中，开发人员可以根据规范选择性地遵循相应的规则，并结合工具和代码审查等方法来确保代码符合 MISRA C++ 规范的要求。

需要注意的是，MISRA C++ 规范是一种指导性的规范，可以帮助开发人员编写高质量、可靠的 C++ 代码，但它并不适用于所有项目和情况。在实际使用中，应根据项目需求和团队约定来决定是否采用

MISRA C++ 规范以及具体遵循哪些规则。

[CC++]编程规范一：头文件篇

[CC++]编程规范一：头文件篇

[CC++]编程规范⼀：头⽂件篇

⼀般来说，每⼀个.cc或者.cpp⽂件对应⼀个头⽂件(.h⽂件)，当然，也有例外，例如⼀些测试单元或者main⽂件，头⽂件的⼀些规范可以令代码可读性、程序的性能等⼤为改观，所以还是要注意头⽂件的规范问题。

⼀、#define保护

所有头⽂件为了防⽌⽂件被多重包含(multiple inclusion)，⼀般就需要#define保护。#define保护的格式如下：

___H_例如：

#ifndef FOO_BAR_BARZ_H_#define FOO_BAR_BARZ_H_...#endif //FOO_BAR_BARZ_H_这个是⽐较⽼的⼀个做法了，所以很多编译器基本都是可以兼容的，但是还有另⼀个语句也是可以起到相同作⽤，但是⼀些太⽼的编译器据说⽤不了的(但是我好像没遇到过)，VS下好像默认新建⼀个类的头⽂件就会⽤这个新的:

#program once这⼀种相对于第⼀种的好处是，不通过#define⼀个变量来起到防⽌重复包含，所以，不存在重复变量的问题，#define后⾯的变量在同⼀个⼯程⾥是不能重复的，重复的话是只认⼀个的，就可能导致另⼀个⽂件编译的时候被排除。

⼆、头⽂件依赖

在头⽂件中减少包含其他头⽂件，改⽤前置声明(forward declarations)，理由是：头⽂件被包含的同时会引⼊⼀项新的依赖(dependency)，只要头⽂件被修改，代码就要重新编译，如果你的头⽂件包含了其它头⽂件，这些头⽂件的任何改动都将导致那些包含了你的头⽂件的代码重新编译。

使⽤前置声明就是在头⽂件中添加：

class Foo;然后在对应的源⽂件中包含对应的头⽂件

#include 可以这么做的⼏种情况：

1)、将数据声明为指针(Foo*)或者引⽤(Foo&)；

2)、参数、返回值为Foo的函数只声明不定义；

3)、静态数据成员可以被声明为Foo，因为静态数据成员的定义在类定义之外；

但是，如果你的类是Foo的⼦类或者包含类型为Foo的⾮静态成员数据，则必须包含头⽂件。

c++开发 规约

c++开发 规约

在进行C++开发时，以下是一些常见的规约（也称为编码规范）：

1. 命名规约：

- 使用有意义的命名：变量、函数、类等的名称应该清晰、准确地描述其用途和功能。

- 遵循命名惯例：使用驼峰命名法或下划线命名法，并保持一致性。

- 避免使用单个字符作为名称，除非是临时变量或循环计数器。

2. 缩进和空格：

- 使用合适的缩进：通常是使用四个空格来缩进代码块，以增强可读性。

- 使用适当的空格：在操作符周围、函数调用的参数之间、逗号后面等添加空格，以提高代码的可读性。

3. 注释规约：

- 在代码中添加注释：解释代码的功能、目的和实现细节等。

- 更新注释：当修改代码时，确保及时更新相关的注释。

4. 函数规约：

- 函数长度：尽量保持函数简短和聚焦。如果函数过长，考虑将其拆分成更小的函数。

- 单一职责原则：每个函数应该只负责一项具体的任务。

5. 错误处理：

- 合理处理错误：避免忽略错误，适当地处理异常情况。

- 错误信息：提供有用和明确的错误信息，以便于调试和排除问题。

6. 内存管理：

- 避免内存泄漏：确保在不再需要时释放动态分配的内存。

- 合理使用指针和引用：避免悬挂指针和无效引用。

7. 文件组织：

- 逻辑分组：将相关的类、函数和变量组织在一起，使代码更易于阅读和维护。

- 头文件保护：使用预处理指令（如 #ifndef、#define、#endif）来确保头文件只包含一次。

以上只是一些常见的规约，实际开发中还有更多细节需要考虑。另外，如果你正在参与一个团队项目，还应该遵守团队内部的编码规范和约定。

C++编程规范及要求

C++编程规范及要求

C++编码规范及要求

王卓

2008-02-21 版本 第一次编写

有关C、C++的编码风格和程序质量可以参照《高质量C/C++编程》 1 概述 错误!未定义书签。

2 字体及颜色 错误!未定义书签。

3 文件结构 错误!未定义书签。

文件头注释 错误!未定义书签。

头文件 错误!未定义书签。

实现文件 错误!未定义书签。

文件的组织结构 错误!未定义书签。

4 命名规则 错误!未定义书签。

类/结构 错误!未定义书签。

函数 错误!未定义书签。

变量 错误!未定义书签。

常量 错误!未定义书签。

枚举、联合、typedef 错误!未定义书签。

宏、枚举值 错误!未定义书签。

名空间 错误!未定义书签。

5 代码风格与版式 错误!未定义书签。

类/结构 错误!未定义书签。

函数 错误!未定义书签。

变量、常量 错误!未定义书签。

枚举、联合、typedef 错误!未定义书签。

宏 错误!未定义书签。

名空间 错误!未定义书签。

异常 错误!未定义书签。

概述

高品质、易维护的软件开发离不开清晰严格的编码规范。

本文档详细描述C++软件开发过程中的编码规范。

本规范也适用于所有在文档中出现的源码。

字体及颜色

强烈推荐采用Visual Assist X作为Visual Studio的辅助工具。在编辑源码时，应该根据编辑器支持的自定义选项最大限度地满足下表定义的高亮规范。

类型 颜色 举例

注释 R0;G128;B0（深绿）

.

类、结构、联合、枚举 R0;G0;B255（蓝） class CMyClass, enum ERRTYPE, typedef

int CODE ...

名空间 R0;G0;B255（蓝） namespace BaiY

数字 R255;G0;B0（红） 012 119u 0xff ...

字符、字符串 R0;G128;B128（深蓝绿） "string", 'c ...