C/C++语言编码规范
来自:CSDN
1.说明
为了保证在软件开发过程中，全体成员的代码风格一致，便于维护，提高软件产品的质量和保持开发产品的延续性，特制定本编码规范。本规范详细规定了源代码书写、变量命名、函数/过程的书写、错误和异常处理等方面。
2. 程序约定
2.1 排版规则
程序应采用缩进风格编写，每层缩进使用一个制表位（TAB），类定义、方法都应顶格书写；
左花括号要另起一行，不能跟在上一行的行末；
一个变量定义占一行，一个语句占一行；
对独立的程序块之间、变量说明之后必须加空行；
对于较长的语句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读；
循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分；
在结构成员赋值等情况，等号对齐，最少留一个空格；
若函数或过程中的参数较长，则要进行适当的划分。
形参的排序风格：
Ø 最常使用的参数放在第一位；
Ø 输入参数列表应放在输出参数列表的左边；
Ø 将通用的参数放在特殊的参数的左边
2.2 命名约定
2.2.1
应用程序的命名
“公司缩写”+模块名称+[版本]
2.2.2 子模块的命名
每个子模块的名字应该由描述模块功能的1-3以单词组成。每个单词的首字母应大写。在这些单词中可以使用一些较通用的缩写。
2.2.3 变量的命名
变 量的命名的基本原则是使得变量的含义能够从名字中直接理解。可以用多个英文单词拼写而成，每个英文单词的首字母要大写，其中英文单词有缩写的可用缩写；变 量的前缀表示该变量的类型；对于作用域跨越10行以上的变量名称不能少于4个字符，除循环变量，累加变量外不得使用I、j、k等名称的变量。变量分为取全 局变量和局部变量，对于全局变量以加前缀“g_”来区分。
另外，要注意的是：全局变量在程序中不要定义太多，能用局部变量的就用局部变量。如果要使用相关的变量，建议采用类的方式或者结构的方式存放，以减少具体变量的个数。
2.2.4
常量的命名
常量所有的字母均为大写。并且单词之间使用下划线”_”隔开。
2.2.5 函数/过程的命名
函数/过程名称应该尽量使用能够表达函数功能的英文名称，函数名称中应该禁止使用如同function1,function2等含义不清的名称。单词间应该使用大小写分隔。全局函数/过程名称以“g_”前缀开始。
2.2.6 接口命名
接口名称要以大写字母开头。如果接口包含多个单词，每个单词的首字母大写，其他字母小写，如果，这些单词是缩略语（例如XML），也要首字母大写，其他字母小写(写为Xml)
2.2.7 类的命名
类名称要以大写字母开头；
类名称如果包含多个单词，每个单词的首字母要大写，其他字母小写；如果这些单词是缩略语（例如XML），也要首字母大写,其他字母小写（写作Xml）；
类名称应该是一个名词或名词短语；
类成员变量的命名规则与上述规则相同，但是要以“m_”开始，表示其为成员变量（Member）；
类名称不能出现下划线。
2.2.8 方法的命名
方法名称以小写字母开头；
方法名称如果包含多个单词，除了第一个单词外，每个单词的首字母大写，其它字母小写。如果这些单词是缩略语（例如XML），也要首字母大写，其它字母小写（写作Xml）。
方法名称应该是一个动词或动名词短语，意思是“完成什么功能”，“执行什么操作”；
2.2.9 数据库的命名
表：采用“模块名简称+前缀+’_’+表名”的命名规则。
Ø 表名Ø 以能理解该表的内容为原则，Ø 可由中文表示，Ø 也可由代表此表含义的英文字母组成，Ø 首字母大写；
Ø 前缀代表此表类别。
视图：采用“模块名+’_’+视图名+’视图’”的命名规则，通常由8个以内汉字组成。
存储过程：采用“Proc+模块名+’_’+存储过程名”的命名规则。
触发器：采用“模块名+’_’+触发类型+’_’+表名”的命名规则，如果有多个触发类型，则可以叠加在一起。
字 段：字段的命名以能理解该字段的含义为原则，通常由多个英文单词加前缀拼写而成，而组成字段名称的首字母应大写。单词有缩写的可用缩写。字段的前缀表示该 字段的数据类型，其取值详见“数据类型”描述。原则上，字段的命名长度不超过18字节；描述字段的中文名称，用数据库创建工具设计数据库时，需要输入。
2.3 参数的约定
2.3.1 输入参数的约定
有些函数有输入参数，这些参数指由函数外部（调用者）输入，并在函数内部使用。在函数业务流程说明后跟输入参数说明区，用“输入参数”或“Input Parameters”标记。在参数名列表中的每个参数后增加该参数的注释。
2.3.2 输出参数的约定
有 些函数有输出参数，这些参数指由函数外部（调用者）定义，在函数内部使用并返回给调用者的参数。在输入参数说明区后跟输出参数说明区，用“输出参数”或 “Output Parameters”标记。在参数名列表中的每个参数后增加该参数的注释。另外输出参数一般以指针或应用输出。
2.3.3 返回值的约定
每 个函数均有返回值，除非操作非常简单。对于有不同状态的返回值，建议用long型的返回值，0为成功。对于出错类返回值，在同一层次的模块，用统一代码表 示。在输出参数说明区后跟返回值说明区，用“返回值”或“Return values”标记。返回值说明，要说明各种不同类型返回值以及它们的含义。
2.4 注释约定
在软件中对每个文件头,自定义函数和变量,重要的处理过程都要有必要的注释。
2.4.1 源程序头的注释和规范
每个文件头插入注释，标明文件的用途和作者，注释如下：(注释尽量用中文)
//程序名称
//版权说明
//版本号：
//功能：
//开发人：
//开发时间：
//修改者：
//修改时间
//修改简要说明
//其他
2.4.2 函数的注释
每个函数前面注明函数的功能和输入，输出。注释为：
//名称
//功能：（说明函数的功能）
//输入参数：（说明每个输入参数的用途和取值约定）
//输出参数：（说明每个输出参数的用途和取值约定）
//返回：（说明返回值，返回值的含义和约定）
2.4.3 变量注释
直接在变量后面注明变量的用途和取值约定，如：
int status; //记录处理状态，0: 成功，1: 错误
2.4.4 类型定义注释
指类和记录等等定义的注释。在注释中标明定义的用途。
2.4.5 区的注释
同一个类的成员方法要求排列在一起，共同协作而实现同一个功能的函数和过程要求排列在一起。代码通常使用几个函数和过程来实现某一项功能，这时候需要使用区注释将这些具有共同目的的函数和过程标明出来。
使用整行的”*”作为隔离行，让程序清晰可读。
一般删除的代码不建议直接删除,最好用“//”注释起来。
2.4.6 代码中的注释
在代码中要求注释的地方有:
代码中的关键部分；
在使用特殊算法或者逻辑性较强的代码；
在修改或删除代码部分,需要加注释;修改/删除人,目的.
2.5 变量的作用范围
尽量做到缩小变量的作用范围，对于变量是指针的，应遵循以下约定：
在局部分配的空间在局部释放。
函数体内不能分配空间并将空间指针作为函数参数返回。
动态全局空间在程序结束时一定要释放。
所有动态分配的空间在对应层次的模块释放，并且用完马上释放。不重复释放相同的指针。
2.6 函数/过程的定义
在函数的定义处应当增加本函数的功能描述的注释。
用一句话描述清楚功能。
可用英文或中文。
功能注释格式要求所有代码一致。
2.7 函数业务流程的定义
在函数功能描述后，要增加函数的主要业务流程注释。
可以用多行描述，以解释清楚业务流程为主。
可用英文或中文。
业务流程注释格式要求所有代码一致。
业务流程注释可以尽量详细，注释的长度可以与代码长度差不多，但是不要太长。
比如处理N阶乘的函数业务流程定义如下：
/* Process: N factorial use callback function to implement. If N == 0 then */
/* return 1 else return N-1 factorial. */
或
/* 过程：N阶乘利用回调函数实现。如果N等于零，则返回1， */
/* 否则返回 N-1的阶乘。 */
注意：函数业务流程的说明并不在乎有多长，但是在乎能否说明过程。有些像N阶乘的函数流程比较简单，但是有些比较复杂。当比较复杂时，可以用标号来说明。
3. 接口/函数过程调用的约定
几乎每一个项目中，都存在开发接口API给其他应用调用，本规范适用于标准C开发接口API。
3.1 头文件（.h文件）
提供给使用API的应用的标准C头文件。头文件必须包含三部分。
防止头文件重复引用的编译条件
即我们在创建头文件时必须增加以下的条件编译：#ifndef #define #endif。比如要防止abcqueue.h头文件被重复引用，必须在abcqueue.h增加以上的条件编译：
#ifndef _ABCQUEUE_H
#define _SMBUS_H
……
#endif
函数定义
函数的定义是为了方便应用知道LIB、DLL里引出了怎样的API，应该如何使用。如上面的例子。
错误代码定义
错误代码是接口API里因为内部某种错误返回的代码，它告诉应用出现了什么错误，以便开发者进行调试和排错。
3.2 函数
提供给应用调用的执行体。实现函数时，必须根据以下规范开发
3.2.1
变量定义
在函数代码中，变量的定义必须放在第一部分，同时给指针类型的变量赋空（NULL）。
3.2.2 参数合法性检查
在使用应用传递的输入输出参数之前，必须对参数进行合法性检查，保证代码执行使用参数的安全性。比如，应用的一个输出参数地址为NULL，如果处理之前不检查参数的合法性，那么将导致一个内存错误；如果检查合法性，就不会造成代码执行时出现问题。
3.2.3执行处理
在处理代码开发中，必须注意以下的一系列的问题：
对应用传递的输入输出参数，禁止使用strcpy, strlen, strcat, strcmp等相应的函数操作输入输出参数，尽量使用strncpy, memcpy等含有处理长度参数的函数进行处理。
必须先分配系统资源，才能分配函数内部需要的资源；相反，必须首先释放函数内部分配的资源，再释放系统资源。
3.2.4 返回值
对外接口API必须返回返回值给应用。
4. 错误和异常处理规范
4.1 出错类型定义约定
在整个系统软件产品的出错定义要一致；
统一模块层次的出错类型统一定义；
出错类型分为错误、警告、提示等三类信息，分别用E、W、I开头；
错误代码统一用宏描述，并且放在一个头文件中；
出错代码的宏定义还要加注对这个代码的说明；
出错代码有相应的文档指明代码的定义规则。
例子：有ErrorDef.h中有如下定义：
// **************************************************************
// Error Code Macro Define
// **************************************************************
// Error Code
#define E_OK 0x0 // 没有错误
#define E_NO_ENOUGH_MEMORY 0x1001 // 内存不足
#define E_INVALID_HANDLE 0x1002 // 无效的句柄
// Warning Code
#define W_CUT_RECV_DATA 0x2001 // 裁剪接收数据
#define W_ FIND_OLD_MESSAGE 0x2002 // 发现老的消息
// Information Code
#define I_SEND_SUCCEED 0x9001 // 发送成功
注意：出错类型的定义一定要统一，并且一定要注意编码问题。
4.2异常的捕获
在程序中会出现各种异常，如除0错误、内存错误都要处理。要有异常可能的都要捕获。
4.3异常和错误的处理
每个函数独立处理内部的异常，对影响结果的异常通过返回值返回。对于在函数内部不能处理的异常，捕获后已另外的形式向调用者抛出，但是要在接口文档中详细写明。
注意：处理异常一般有两种方法，一是通过将异常转化为另一个异常抛出，二是通过函数返回值返回。在本规范中，我们倾向于用第二种方法。
扫一扫
1849
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
