编码规范

C++语言编码规范

一、尽量严格按照要求书写代码，统一书写格式。详细格式参照《参考1_程序格式》。

二、所有头文件都应该使用#define保护来防止头文件被多重包含。

通用的方法：

#ifndef _IPROPETRY_H #define _IPROPETRY_H …… #endif

VC中可以使用的方法： #pragma once

三、使用前置声明等方法，尽量减少头文件依赖；

#pragma once class CUser;

class CTest { public: };

CTest(void); ~CTest(void); CUser* m_pUser;

四、包含的文件应按照项目源代码目录树结构排列，避免使用.（当前目录）和..（父目录）。

例如：

D:\\Work\\project\\src\\base\\logging.h 应该像返样被包含： #include \

五、包含头文件的顺序如下：

CPP的头文件 C系统文件 C++系统文件 其他库头文件 本项目内头文件

六、编写短小的函数，超过200行的函数可以考虑将它拆分；

七、不要使用magic number；把常数定义成常量或者宏来使用；

例子一：

const int iDmdCount = 8;

for (int i=0; i

例子二：

int iDmdOffset[] = { };

int iCount = sizeof(iDmdOffset) / sizeof(iDmdOffset[0]); for (int i=0; i

101, 100, 100, 99,

八、合理使用参数有效性判断和断言；

extern \ RDP_MODULE_PORT int scan_GenerateData(DataBuffersScanning* pBuf) { }

assert(p_GrayScan);

return p_GrayScan->GenerateData(pBuf);

九、对于迭代器和其他模板对象使用前缀形式（++i）的自增、自减运算符。

for (int i=0; i

十、在任何可以使用的情况下使用const。

A、 类成员函数的const修饰保证这个函数不会修改类的变量； B、 指向Const数据的指针，保证指向的这段数据不会被修改； C、 可以使用const_cast去掉const属性；

十一、 按照命名约定来给变量、函数、类起名。

*类从成员函数使用m_ 做前缀

十二、 使用枚举类型来增加程序的可读性。

十三、 在处理用户输入、打开文件等操作时候要异常小心。

十四、 尽量简化和复用代码。

这是一个长期反复迭代的过程。是对代码进行泛化和抽象的过程。 十五、 编写结构清晰、简单明了的代码。

有关编码的要求和一些详细建议，请看《参考2_编程规范和范例_华为.doc》和《参考3_google_c++编程风格.pdf》。

本文来源：https://www.bwwdw.com/article/15or.html