C语言编码规范

C语言编码规范

文档修改记录

版本版本日期说明编写者审核者V0.1吕晓敏

1排版规则

1)程序应采用缩进风格编写，每层缩进使用一个制表位（TAB），类定义、方法都应顶

格书写；

2)源程序建议使用英文书写，尽量不含有中文。每行不超过80字符。对于较长的语

句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读；循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分；

3)左花括号要另起一行，不能跟在上一行的行末；

4)一个变量定义占一行，一个语句占一行；

5)对独立的程序块之间、变量说明之后必须加空行；

6)在结构成员赋值等情况，等号对齐，最少留一个空格；

7)若函数或过程中的参数较长，则要进行适当的划分。

8)形参的排序风格：

最常使用的参数放在第一位；

输入参数列表应放在输出参数列表的左边；

将通用的参数放在特殊的参数的左边。

2命名规范

2.1应用程序的命名

“系统简称”+模块名称

2.2子模块的命名

每个子模块的名字应该由描述模块功能的1-3以单词组成。每个单词的首字母应大写。在这些单词中可以使用一些较通用的缩写。

2.3变量的命名

变量的命名的基本原则是使得变量的含义能够从名字中直接理解。可以用多个英文单词拼写而成，每个英文单词的首字母要大写，其中英文单词有缩写的可用缩写；变量的前缀表示该变量的类型；对于作用域跨越10行以上的变量名称不能少于4个字符，除循环变量，累加变量外不得使用I、j、k等名称的变量。变量分为取全局变量和局部变量，对于全局变量以加前缀“g_”来区分。

使用有意义的英语单词,使用大小写分隔,每个单词的第一个字母为大写标识符种类书写规范示例

函数/过程名/变量一般标识符CheckButtonStates

宏标识符大写标识符SALES_TAX

类型定义‘T’+一般标识符TMyType

类标识符‘C’+一般标识符CEditBox

结构标识符‘S’+一般标识符SMyStructure

联合标识符‘U’+一般标识符UMyUnion

字符标识符‘c’+一般标识符cReadKey

字符串标识符‘s’+一般标识符sComputerName

整数标识符‘i/ui/l/ul’+一般标识

符iNumber,ulCurrent

浮点型标识符‘f/d’+一般标识符fPrice,dMoney 逻辑标识符‘b’+一般标识符bIsDetailed

对象标识符特征小写字母+一般标

识符fMyStatus,tMyTree

指针变量p+类型前缀+一般标识

符piCount

全局变量g+类型前缀+一般标识

符giCount

类私有变量f+类型前缀+一般标识

符fiCount

数据库变量以m打头miCount

考虑到习惯性和简洁性，对于按常规使用的局部变量允许采用极短的名字，如用n、i作为循环变量，p、q作为指针等。另外，要注意的是：全局变量在程序中不要定义太多，能用局部变量的就用局部变量。如果要使用相关的变量，建议采用类的方式或者结构的方式存放，以减少具体变量的个数。

2.4常量的命名

常量所有的字母均为大写。并且单词之间使用下划线”_”隔开。

2.5函数/过程的命名

函数/过程名称应该尽量使用能够表达函数功能的英文名称，函数名称中应该禁止使用如同function1,function2等含义不清的名称。单词间应该使用大小写分隔。全局函数/过程名称以“g_”前缀开始。

2.6接口命名

接口名称要以大写字母开头。如果接口包含多个单词，每个单词的首字母大写，其他字母小写，如果，这些单词是缩略语（例如XML），也要首字母大写，其他字母小写(写为Xml)。

2.7类的命名

类名称要以大写字母开头；

类名称如果包含多个单词，每个单词的首字母要大写，其他字母小写；如果这些单词是缩略语（例如XML），也要首字母大写,其他字母小写（写作Xml）；

类名称应该是一个名词或名词短语；

类成员变量的命名规则与上述规则相同，但是要以“m_”开始，表示其为成员变量（Member）；

类名称不能出现下划线。

2.8方法的命名

方法名称以小写字母开头。

方法名称如果包含多个单词，除了第一个单词外，每个单词的首字母大写，其它字母小写。如果这些单词是缩略语（例如XML），也要首字母大写，其它字母小写（写作Xml）。

方法名称应该是一个动词或动名词短语，意思是“完成什么功能”，“执行什么操作”。

2.9数据库的命名

2.9.1表：

采用“模块名简称+前缀+’_’+表名”的命名规则。表名以能理解该表的内容为原则，可由中文表示，也可由代表此表含义的英文字母组成；首字母大写；前缀代表此表类别。

2.9.2视图：

采用“模块名+’_’+视图名+’视图’”的命名规则，通常由8个以内汉字组成。

2.9.3存储过程：

采用“Proc+模块名+’_’+存储过程名”的命名规则。

2.9.4触发器：

采用“模块名+’_’+触发类型+’_’+表名”的命名规则，如果有多个触发类型，则可以叠加在一起。

2.9.5字段：

字段的命名以能理解该字段的含义为原则，通常由多个英文单词加前缀拼写而成，而组成字段名称的首字母应大写。单词有缩写的可用缩写。字段的前缀表示该字段的数据类型，其取值详见“数据类型”描述。原则上，字段的命名长度不超过18字节；描述字段的中文名称，用数据库创建工具设计数据库时，需要输入。

3参数的约定

3.1输入参数的约定

有些函数有输入参数，这些参数指由函数外部（调用者）输入，并在函数内部使用。在函数业务流程说明后跟输入参数说明区，用“输入参数”或“Input Parameters”标记。在参数名列表中的每个参数后增加该参数的注释。

3.2输出参数的约定

有些函数有输出参数，这些参数指由函数外部（调用者）定义，在函数内部使用并返回给调用者的参数。在输入参数说明区后跟输出参数说明区，用“输出参数”或“Output Parameters”标记。在参数名列表中的每个参数后增加该参数的注释。另外输出参数一般以指针或应用输出。

3.3返回值的约定

每个函数均有返回值，除非操作非常简单。对于有不同状态的返回值，建议用long

型的返回值，0为成功。对于出错类返回值，在同一层次的模块，用统一代码表示。在输出参数说明区后跟返回值说明区，用“返回值”或“Return values”标记。返回值说明，要说明各种不同类型返回值以及它们的含义。

4注释约定

在软件中对每个文件头,自定义函数和变量,重要的处理过程都要有必要的注释。

4.1源程序头的注释和规范

每个源程序（包括存储过程）必须有头部说明、版本说明和函数结构三个部分：

源程序头部说明

FileName: Copy Right: System: Module: Function: See also: Author: Create Date:本程序的外部名字（如*.prg,*.cpp）xxx公司版权所有版本信息

本文件所在的系统或工程的名字

本文件所在的功能模块名称

简要说明本程序的功能

相关详细设计文档号

编码人员

创建日期

源程序版本说明

Editor：Version：Edit Date：修改人员版本号修改日期

4.2函数头的注释和规范

Name: Function: Input:

Output:

Return:

Syntax: Env: Calling:函数名称

简述函数或过程的功能[参数1]－[说明…] [参数2]－[说明…] [参数1]－[说明…] [参数2]－[说明…] [返回码1]－[说明…] [返回码2]－[说明…]调用语法(可选)

环境要求和影响(可选的)被调用的函数(可选的)

4.3变量注释

直接在变量后面注明变量的用途和取值约定，例如：int status;//记录处理状态，0:成功，1:错误

4.4类型定义注释

指类和记录等等定义的注释。在注释中标明定义的用途。

4.5区的注释

同一个类的成员方法要求排列在一起，共同协作而实现同一个功能的函数和过程要求排列在一起。代码通常使用几个函数和过程来实现某一项功能，这时候需要使用区注释将这些具有共同目的的函数和过程标明出来。

使用整行的”*”作为隔离行，让程序清晰可读。

一般删除的代码不建议直接删除,最好用“//”注释起来。

4.6代码中的注释

在代码中要求注释的地方有:

代码中的关键部分；

在使用特殊算法或者逻辑性较强的代码；

在修改或删除代码部分,需要加注释;修改/删除人,目的。

5变量的作用范围

尽量做到缩小变量的作用范围，对于变量是指针的，应遵循以下约定：

在局部分配的空间在局部释放。

函数体内不能分配空间并将空间指针作为函数参数返回。

动态全局空间在程序结束时一定要释放。

所有动态分配的空间在对应层次的模块释放，并且用完马上释放。不重复释放相同的指针。

6函数/过程的定义

在函数的定义处应当增加本函数的功能描述的注释。用一句话描述清楚功能。可用英文或中文。功能注释格式要求所有代码一致。

7函数业务流程的定义

在函数功能描述后，要增加函数的主要业务流程注释。可以用多行描述，以解释清楚业务流程为主。可用英文或中文。业务流程注释格式要求所有代码一致。

业务流程注释可以尽量详细，注释的长度可以与代码长度差不多，但是不要太长。比如处理N阶乘的函数业务流程定义如下：

/*Process:N factorial use callback function to implement.If N==0then*/ /*return1else return N-1factorial.*/

或

/*过程：N阶乘利用回调函数实现。如果N等于零，则返回1，*/

/*否则返回N-1的阶乘。*/

注意：函数业务流程的说明并不在乎有多长，但是在乎能否说明过程。有些像N阶乘的函数流程比较简单，但是有些比较复杂。当比较复杂时，可以用标号来说明。

8接口/函数过程调用的约定

8.1头文件（.h文件）

提供给使用API的应用的标准C头文件。头文件必须包含三部分。

1)防止头文件重复引用的编译条件，即我们在创建头文件时必须增加以下的条件编

译：

#ifndef#define#endif。比如要防止abcqueue.h头文件被重复引用，必须在abcqueue.h增加以上的条件编译：

#ifndef_ABCQUEUE_H

#define_SMBUS_H

……

#endif

2)函数定义

函数的定义是为了方便应用知道LIB、DLL里引出了怎样的API，应该如何使用。如上面的例子。

3)错误代码定义

错误代码是接口API里因为内部某种错误返回的代码，它告诉应用出现了什么错误，以便开发者进行调试和排错。

8.2函数

8.2.1函数体书写规范

8.2.1.1格式化要求

每个函数代码行数应控制在400行内(不包含注释)。

用缩行显示程序结构，缩进量统一使用4个空格。

循环、分支层次不要超过五层。

括号风格采用列对齐方式，即“{”与相匹配的“}”在同一列对齐，如：

if(…)

{

…

}

而不是：

if(…){

…

}

函数参数定义采用现代风格，如：

int main(int argc,char*argv[])

而不是：

int main(argc,argv)

int argc;

char*argv[];

如果包含在条件判断和循环体中的内容比较多,结束时说明匹配的条件:

if(a!=b)

{

…

…

}/*end if(a!=b)*/

8.2.1.2合理使用空格

合理使用空格分隔语句中的各种元素，使源程序舒展，可读：

运算符两边加空格；

‘：’、’，’后跟空格；

‘if’、‘for’等关键字后跟空格；

两个函数之间至少留一空行。

8.2.1.3表达式的要求

尽量避免含有否定运算的条件表达式；

如：if(!(num>=10))应改为：if(num<10)

为避免二义性，对于复杂的表达式不论是否必要都采用加括号来分组；

如：leap_year=(year%4==0)&&(year%100!=0)||(year%400==0)；

8.2.1.4宏定义要求

宏体和参数都要加上括号，如：

#define square((x)*(x))

为杜绝可能带来的副作用，尽量避免采用函数宏。

8.2.1.5注释的要求

注释要清晰，与代码保持一致，避免没有价值的注释；

保持注释与代码完全一致。

对于全局标识符（函数、全局变量、常量定义等）必须要加注释；

UNIX下C程序或存储过程注释统一用/*和*/,不允许用//；

循环语句要有注释。

分支语句要有注释。

数据库语句要有注释。

主要变量（结构、联合、类或对象）定义或引用时，注释能反映其含义。

处理过程的每个阶段都有相关注释说明。

在典型算法前都有注释。

注释可以与语句在同一行，也可以在上行。

注释行数（不包括程序头和函数头说明部份）应占总行数的1/5到1/3。 对函数中某处细节进行修改必须留下注释，其格式如下：

<程序源代码>/*[修改原因][修改者][日期]*/

8.2.2头文件书写顺序约定

文件头:

包含的头文件:

符号常数和全局常数:宏定义:

类型定义:

结构，联合和类定义:外部变量说明:

内联函数定义:见程序头部书写标准

#include

const或#define

macro或#define typedef

struct|union|class

8.2.3通用库函数文件

库函数源程序除了遵照以上的源程序规范外，还应遵守下面的规定：

文件大小需简短。不将没有关联的函数放在一个源文件中。尽量使函数独立。以减小最后联结的目标码的长度。

除极特别情况外，不使用全局变量。

函数的输入参数，如果是指针时，使用const修饰符定义。

必须在相应的头文件中，定义函数的调用原型。以利于编译系统检查调用者的调用格式错误，减少编码的出错机会。

8.2.4变量定义

在函数代码中，变量的定义必须放在第一部分，同时给指针类型的变量赋空（NULL）。

8.2.5参数合法性检查

在使用应用传递的输入输出参数之前，必须对参数进行合法性检查，保证代码执行使用参数的安全性。比如，应用的一个输出参数地址为NULL，如果处理之前不检查参数的合法性，那么将导致一个内存错误；如果检查合法性，就不会造成代码执行时出现问题。

8.2.6执行处理

在处理代码开发中，必须注意以下的一系列的问题：

对应用传递的输入输出参数，禁止使用strcpy,strlen,strcat,strcmp等相应的函数操作输入输出参数，尽量使用strncpy,memcpy等含有处理长度参数的函数进行处理。

必须先分配系统资源，才能分配函数内部需要的资源；相反，必须首先释放函数内部分配的资源，再释放系统资源。

禁止出现两条等价的支路。

禁止GOTO语句。

用IF语句来强调只执行两组语句中的一组。禁止ELSE GOTO和ELSE RETURN。

用CASE实现多路分支。

避免从循环引出多个出口。

函数只有一个出口。

不使用条件赋值语句。

避免不必要的分支。

不要轻易用条件分支去替换逻辑表达式。

8.2.7返回值

对外接口API必须返回返回值给应用。

9错误和异常处理规范

错误分业务错误和系统错误两类。错误提示包含错误代码和提示信息两部分，其中错误代码长度固定为四个字符，提示信息长度不定，但最长不超过60个字符。

错误发生源作为提示信息的一部分。所有出错都要详细记录错误日志。

建议设立错误代码与提示信息的对照表，根据错误代码来查找相应的提示信息。

日终批处理过程中出错要记入LOG文件。

9.1出错类型定义约定

在整个系统软件产品的出错定义要一致；

统一模块层次的出错类型统一定义；

出错类型分为错误、警告、提示等三类信息，分别用E、W、I开头；错误代码统一用宏描述，并且放在一个头文件中；

出错代码的宏定义还要加注对这个代码的说明；

出错代码有相应的文档指明代码的定义规则。

例子：有ErrorDef.h中有如下定义：

//**************************************************************

//Error Code Macro Define

//**************************************************************

//Error Code

#define E_OK0x0//没有错误

#define E_NO_ENOUGH_MEMORY0x1001//内存不足

#define E_INVALID_HANDLE0x1002//无效的句柄

//Warning Code

#define W_CUT_RECV_DATA0x2001//裁剪接收数据

#define W_FIND_OLD_MESSAGE0x2002//发现老的消息

//Information Code

#define I_SEND_SUCCEED0x9001//发送成功

注意：出错类型的定义一定要统一，并且一定要注意编码问题。

9.2异常的捕获

在程序中会出现各种异常，如除0错误、内存错误都要处理。要有异常可能的都要

捕获。

9.3异常和错误的处理

每个函数独立处理内部的异常，对影响结果的异常通过返回值返回。对于在函数内部不能处理的异常，捕获后已另外的形式向调用者抛出，但是要在接口文档中详细写明。注意：处理异常一般有两种方法，一是通过将异常转化为另一个异常抛出，二是通过函数返回值返回。在本规范中，倾向于用第二种方法。

附录：C程序模版

/***************************************************************

源程序名称:软件著作权:系统名称:模块名称:功能说明:相关文档:作者:

审核:AB41Chec.c

xxx公司版权所有版本信息

本文件所在的系统或工程的名字本文件所在的功能模块名称

简要说明本程序的功能

相关详细设计文档号

(可选)

$Author$

$Revision$

$Date$

*******************************************************************/

#include/***include文件**/

#include

#define MAX_LEN10

/*******************函数说明*************************************

函数名称:

功能:

入口参数说明:出口参数说明:返回码:

调用格式:

对环境引用:对环境影响:调用函数列表:被调函数列表:中文名称(可选的)

简述函数或过程的功能[参数1]－[说明…] [参数2]－[说明…] [参数1]－[说明…] [参数2]－[说明…] [返回码1]－[说明…] [返回码2]－[说明…] (可选的)

(可选的)

(可选的)

(可选的)

(可选的)

*****************************************************************/ int func1(int arg1,char*arg2)/*函数说明用现代风格*/

{/*扩号用列对齐方式*/ char buf[MAX_LEN];/*数组长度采用符号常量*/

}