文档库 最新最全的文档下载
当前位置:文档库 › C C++编程规范总则

C C++编程规范总则

C C++编程规范总则
C C++编程规范总则

1 排版 (5)

11-1:程序块要采用缩进风格编写,缩进的空格数为4个。 (5)

11-2:相对独立的程序块之间、变量说明之后必须加空行。 (5)

11-3:较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分

新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。 (5)

11-4:循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式

要在低优先级操作符处划分新行,操作符放在新行之首。 (6)

11-5:若函数或过程中的参数较长,则要进行适当的划分。 (6)

11-6:不允许把多个短语句写在一行中,即一行只写一条语句。 (6)

11-7:if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while

等语句的执行语句部分无论多少都要加括号{}。 (7)

11-8:对齐只使用空格键,不使用TAB键。 (7)

11-9:函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,

case语句下的情况处理语句也要遵从语句缩进要求。 (7)

11-10:程序块的分界符(如C/C++语言的大括号‘{’和‘}’)应各独占一行并且位于

同一列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举

的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。 (7)

11-11:在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、

之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后

不应加空格。 (8)

2 注释 (10)

12-1:一般情况下,源程序有效注释量必须在20%以上。 (10)

12-2:说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部

应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它

文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。 (10)

12-3:源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的

/功能、主要函数及其功能、修改日志等。 (10)

12-4:函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、

调用关系(函数、表)等。 (11)

12-5:边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。

不再有用的注释要删除。 (12)

12-6:注释的内容要清楚、明了,含义准确,防止注释二义性。 (12)

12-8:注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的

注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。 (12)

12-9:对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都

必须加以注释,说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。 (12)

12-10:数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,

必须加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每

个域的注释放在此域的右方。 (13)

12-11:全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取

它以及存取时注意事项等的说明。 (13)

12-12:注释与所描述内容进行同样的缩排。 (13)

12-13:将注释与其上面的代码用空行隔开。 (14)

12-14:对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。 (14)

12-15:对于switch语句下的case语句,如果因为特殊情况需要处理完一个case后进入

下一个case处理,必须在该case语句处理完、下一个case语句前加上明确的注释。 (14)

3 标识符命名 (18)

13-1:标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以

理解的缩写,避免使人产生误解。 (18)

13-2:命名中若使用特殊约定或缩写,则要有注释说明。 (18)

13-3:自己特有的命名风格,要自始至终保持一致,不可来回变化。 (18)

13-4:对于变量命名,禁止取单个字符(如i、j、k...),建议除了要有具体含义外,还

能表明其变量类型、数据类型等,但i、j、k作局部循环变量是允许的。 (18)

13-5:命名规范必须与所使用的系统风格保持一致,并在同一项目中统一,比如采用

UNIX的全小写加下划线的风格或大小写混排的方式,不要使用大小写与下划线混排的方

式,用作特殊标识如标识成员变量或全局变量的m_和g_,其后加上大小写混排的方式是

允许的。 (19)

4 可读性 (21)

14-1:注意运算符的优先级,并用括号明确表达式的操作顺序,避免使用默认优先级。

21

14-2:避免使用不易理解的数字,用有意义的标识来替代。涉及物理状态或者含有物理

意义的常量,不应直接使用数字,必须用有意义的枚举或宏来代替。 (21)

5 变量、结构 (23)

15-1:去掉没必要的公共变量。 (23)

15-2:仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系。 (23)

15-3:明确公共变量与操作此公共变量的函数或过程的关系,如访问、修改及创建等。

23

15-4:当向公共变量传递数据时,要十分小心,防止赋与不合理的值或越界等现象发生。

23

15-5:防止局部变量与公共变量同名。 (23)

15-6:严禁使用未经初始化的变量作为右值。 (23)

6 函数、过程 (30)

16-1:对所调用函数的错误返回码要仔细、全面地处理。 (30)

16-2:明确函数功能,精确(而不是近似)地实现函数设计。 (30)

16-3:编写可重入函数时,应注意局部变量的使用(如编写C/C++语言的可重入函数时,

应使用auto即缺省态局部变量或寄存器变量)。 (30)

16-4:编写可重入函数时,若使用全局变量,则应通过关中断、信号量(即P、V操作)

等手段对其加以保护。 (30)

16-5:在同一项目组应明确规定对接口函数参数的合法性检查应由函数的调用者负责还

是由接口函数本身负责,缺省是由函数调用者负责。 (31)

7 可测性 (39)

17-1:在同一项目组或产品组内,要有一套统一的为集成测试与系统联调准备的调测开

关及相应打印函数,并且要有详细的说明。 (39)

17-2:在同一项目组或产品组内,调测打印出的信息串的格式要有统一的形式。信息串

中至少要有所在模块名(或源文件名)及行号。 (39)

17-3:编程的同时要为单元测试选择恰当的测试点,并仔细构造测试代码、测试用例,

同时给出明确的注释说明。测试代码部分应作为(模块中的)一个子模块,以方便测试代

码在模块中的安装与拆卸(通过调测开关)。 (39)

17-4:在进行集成测试/系统联调之前,要构造好测试环境、测试项目及测试用例,同时

仔细分析并优化测试用例,以提高测试效率。 (39)

17-5:使用断言来发现软件问题,提高代码可测性。 (39)

17-6:用断言来检查程序正常运行时不应发生但在调测时有可能发生的非法情况。 (40)

17-7:不能用断言来检查最终产品肯定会出现且必须处理的错误情况。 (40)

17-8:对较复杂的断言加上明确的注释。 (40)

17-9:用断言确认函数的参数。 (40)

17-10:用断言保证没有定义的特性或功能不被使用。 (40)

17-11:用断言对程序开发环境(OS/Compiler/Hardware)的假设进行检查。 (41)

17-12:正式软件产品中应把断言及其它调测代码去掉(即把有关的调测开关关掉)。 (41)

17-13:在软件系统中设置与取消有关测试手段,不能对软件实现的功能等产生影响。 (41)

17-14:用调测开关来切换软件的DEBUG版和正式版,而不要同时存在正式版本和

DEBUG版本的不同源文件,以减少维护的难度。 (41)

17-15:软件的DEBUG版本和发行版本应该统一维护,不允许分家,并且要时刻注意

保证两个版本在实现功能上的一致性。 (42)

8 程序效率 (44)

18-1:编程时要经常注意代码的效率。 (44)

18-2:在保证软件系统的正确性、稳定性、可读性及可测性的前提下,提高代码效率。

44

18-3:局部效率应为全局效率服务,不能因为提高局部效率而对全局效率造成影响。 (44)

18-4:通过对系统数据结构的划分与组织的改进,以及对程序算法的优化来提高空间效

率。 (44)

18-5:循环体内工作量最小化。 (45)

9 质量保证 (49)

19-1:在软件设计过程中构筑软件质量。 (49)

19-2:代码质量保证优先原则 (49)

19-3:只引用属于自己的存贮空间。 (49)

19-4:防止引用已经释放的内存空间。 (49)

19-5:过程/函数中分配的内存,在过程/函数退出之前要释放。 (49)

19-6:过程/函数中申请的(为打开文件而使用的)文件句柄,在过程/函数退出之前要

关闭。 (49)

19-7:防止内存操作越界。 (50)

19-8:认真处理程序所能遇到的各种出错情况。 (51)

19-9:系统运行之初,要初始化有关变量及运行环境,防止未经初始化的变量被引用。

51

19-10:系统运行之初,要对加载到系统中的数据进行一致性检查。 (51)

19-11:严禁随意更改其它模块或系统的有关设置和配置。 (51)

19-12:不能随意改变与其它模块的接口。 (51)

19-13:充分了解系统的接口之后,再使用系统提供的功能。 (51)

19-14:编程时,要防止差1错误。 (53)

19-15:要时刻注意易混淆的操作符。当编完程序后,应从头至尾检查一遍这些操作符,

以防止拼写错误。 (53)

19-16:有可能的话,if语句尽量加上else分支,对没有else分支的语句要小心对待;

switch语句必须有default分支。 (53)

19-17:Unix下,多线程的中的子线程退出必需采用主动退出方式,即子线程应return

出口。 (54)

19-18:不要滥用goto语句。 (54)

10 代码编辑、编译、审查 (56)

110-1:打开编译器的所有告警开关对程序进行编译。 (56)

110-2:在产品软件(项目组)中,要统一编译开关选项。 (56)

110-3:通过代码走读及审查方式对代码进行检查。 (56)

110-4:测试部测试产品之前,应对代码进行抽查及评审。 (56)

11 代码测试、维护 (58)

111-1:单元测试要求至少达到语句覆盖。 (58)

111-2:单元测试开始要跟踪每一条语句,并观察数据流及变量的变化。 (58)

111-3:清理、整理或优化后的代码要经过审查及测试。 (58)

111-4:代码版本升级要经过严格测试。 (58)

111-5:使用工具软件对代码版本进行维护。 (58)

111-6:正式版本上软件的任何修改都应有详细的文档记录。 (58)

12 宏 (60)

112-1:用宏定义表达式时,要使用完备的括号。 (60)

112-2:将宏所定义的多条表达式放在大括号中。 (60)

112-3:使用宏时,不允许参数发生变化。 (61)

1 排版

11-1:程序块要采用缩进风格编写,缩进的空格数为4个。

说明:对于由开发工具自动生成的代码可以有不一致。

11-2:相对独立的程序块之间、变量说明之后必须加空行。

示例:如下例子不符合规范。

if (!valid_ni(ni))

{

... // program code

}

repssn_ind = ssn_data[index].repssn_index;

repssn_ni = ssn_data[index].ni;

应如下书写

if (!valid_ni(ni))

{

... // program code

}

repssn_ind = ssn_data[index].repssn_index;

repssn_ni = ssn_data[index].ni;

11-3:较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。

示例:

perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN

+ STAT_SIZE_PER_FRAM * sizeof( _UL );

act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied

= stat_poi[index].occupied;

act_task_table[taskno].duration_true_or_false

= SYS_get_sccp_statistic_state( stat_item );

report_or_not_flag = ((taskno < MAX_ACT_TASK_NUMBER)

&& (n7stat_stat_item_valid (stat_item))

&& (act_task_table[taskno].result_data != 0));

11-4:循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。

示例:

if ((taskno < max_act_task_number)

&& (n7stat_stat_item_valid (stat_item)))

{

... // program code

}

for (i = 0, j = 0; (i < BufferKeyword[word_index].word_length) && (j < NewKeyword.word_length); i++, j++)

{

... // program code

}

for (i = 0, j = 0;

(i < first_word_length) && (j < second_word_length);

i++, j++)

{

... // program code

}

11-5:若函数或过程中的参数较长,则要进行适当的划分。

示例:

n7stat_str_compare((BYTE *) & stat_object,

(BYTE *) & (act_task_table[taskno].stat_object),

sizeof (_STAT_OBJECT));

n7stat_flash_act_duration( stat_item, frame_id *STAT_TASK_CHECK_NUMBER

+ index, stat_object );

11-6:不允许把多个短语句写在一行中,即一行只写一条语句。

示例:如下例子不符合规范。

rect.length = 0; rect.width = 0;

应如下书写

rect.length = 0;

rect.width = 0;

11-7:if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。

示例:如下例子不符合规范。

if (pUserCR == NULL) return;

应如下书写:

if (pUserCR == NULL)

{

return;

}

11-8:对齐只使用空格键,不使用TAB键。

说明:以免用不同的编辑器阅读程序时,因TAB键所设置的空格数目不同而造成程序布局不整齐,不要使用BC作为编辑器合版本,因为BC会自动将8个空格变为一个TAB键,因此使用BC合入的版本大多会将缩进变乱。

11-9:函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case 语句下的情况处理语句也要遵从语句缩进要求。

11-10:程序块的分界符(如C/C++语言的大括号‘{’和‘}’)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。

示例:如下例子不符合规范。

for (...) {

... // program code

}

if (...)

{

... // program code

}

void example_fun( void )

{

... // program code

}

应如下书写。

for (...)

{

... // program code

}

if (...)

{

... // program code

}

void example_fun( void )

{

... // program code

}

11-11:在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后不应加空格。

说明:采用这种松散方式编写代码的目的是使代码更加清晰。

由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格,如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为在C/C++语言中括号已经是最清晰的标志了。

在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。给操作符留空格时不要连续留两个以上空格。

示例:

(1) 逗号、分号只在后面加空格。

int a, b, c;

(2)比较操作符, 赋值操作符"="、 "+=",算术操作符"+"、"%",逻辑操作符"&&"、

"&",位域操作符"<<"、"^"等双目操作符的前后加空格。

if (current_time >= MAX_TIME_VALUE)

a =

b + c;

a *= 2;

a =

b ^ 2;

(3)"!"、"~"、"++"、"--"、"&"(地址运算符)等单目操作符前后不加空格。

*p = 'a'; // 内容操作"*"与内容之间

flag = !isEmpty; // 非操作"!"与内容之间

p = &mem; // 地址操作"&" 与内容之间

i++; // "++","--"与内容之间

(4)"->"、"."前后不加空格。

p->id = pid; // "->"指针前后不加空格

(5) if、for、while、switch等与后面的括号间应加空格,使if等关键字更为突出、

明显。

if (a >= b && c > d)

?1-1:一行程序以小于80字符为宜,不要写得过长。

2 注释

12-1:一般情况下,源程序有效注释量必须在20%以上。

说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。

12-2:说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。

示例:下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。

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

Copyright (C), 1988-1999, Huawei Tech. Co., Ltd.

File name: // 文件名

Author: Version: Date: // 作者、版本及完成日期

Description: // 用于详细说明此程序文件完成的主要功能,与其他模块

// 或函数的接口,输出值、取值范围、含义及参数间的控

// 制、顺序、独立或依赖等关系

Others: // 其它内容的说明

Function List: // 主要函数列表,每条记录应包括函数名及功能简要说明

1. ....

History: // 修改历史记录列表,每条修改记录应包括修改日期、修改

// 者及修改内容简述

1. Date:

Author:

Modification:

2. ...

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

12-3:源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。

示例:下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。

/************************************************************ Copyright (C), 1988-1999, Huawei Tech. Co., Ltd.

FileName: test.cpp

Author: Version : Date:

Description: // 模块描述

Version: // 版本信息

Function List: // 主要函数及其功能

1. -------

History: // 历史修改记录

David 96/10/12 1.0 build this moudle

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

说明:Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。History是修改历史记录列表,每条修改记录应包括修改日期、修改者及修改内容简述。

12-4:函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。

示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。

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

Function: // 函数名称

Description: // 函数功能、性能等的描述

Calls: // 被本函数调用的函数清单

Called By: // 调用本函数的函数清单

Table Accessed: // 被访问的表(此项仅对于牵扯到数据库操作的程序)

Table Updated: // 被修改的表(此项仅对于牵扯到数据库操作的程序)

Input: // 输入参数说明,包括每个参数的作

// 用、取值说明及参数间关系。

Output: // 对输出参数的说明。

Return: // 函数返回值的说明

Others: // 其它说明

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

12-5:边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。

12-6:注释的内容要清楚、明了,含义准确,防止注释二义性。

说明:错误的注释不但无益反而有害。

规则2-7:避免在注释中使用缩写,特别是非常用缩写。

说明:在使用缩写时或之前,应对缩写进行必要的说明。

12-8:注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。

示例:如下例子不符合规范。

例1:

/* get replicate sub system index and net indicator */

repssn_ind = ssn_data[index].repssn_index;

repssn_ni = ssn_data[index].ni;

例2:

repssn_ind = ssn_data[index].repssn_index;

repssn_ni = ssn_data[index].ni;

/* get replicate sub system index and net indicator */

应如下书写

/* get replicate sub system index and net indicator */

repssn_ind = ssn_data[index].repssn_index;

repssn_ni = ssn_data[index].ni;

12-9:对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。

示例:

/* active statistic task number */

#define MAX_ACT_TASK_NUMBER 1000

#define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */

12-10:数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。

示例:可按如下形式说明枚举/数据/联合结构。

/* sccp interface with sccp user primitive message name */

enum SCCP_USER_PRIMITIVE

{

N_UNITDATA_IND, /* sccp notify sccp user unit data come */

N_NOTICE_IND, /* sccp notify user the No.7 network can not */ /* transmission this message */

N_UNITDATA_REQ, /* sccp user's unit data transmission request*/ };

12-11:全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。

示例:

/* The ErrorCode when SCCP translate */

/* Global Title failure, as follows */ // 变量作用、含义

/* 0 - SUCCESS 1 - GT Table error */

/* 2 - GT error Others - no use */ // 变量取值范围

/* only function SCCPTranslate() in */

/* this modual can modify it, and other */

/* module can visit it through call */

/* the function GetGTTransErrorCode() */ // 使用方法

BYTE g_GTTranErrorCode;

12-12:注释与所描述内容进行同样的缩排。

说明:可使程序排版整齐,并方便注释的阅读与理解。

示例:如下例子,排版不整齐,阅读稍感不方便。

void example_fun( void )

{

/* code one comments */

CodeBlock One

/* code two comments */

CodeBlock Two

}

应改为如下布局。

void example_fun( void )

{

/* code one comments */

CodeBlock One

/* code two comments */

CodeBlock Two

}

12-13:将注释与其上面的代码用空行隔开。

示例:如下例子,显得代码过于紧凑。

/* code one comments */

program code one

/* code two comments */

program code two

应如下书写

/* code one comments */

program code one

/* code two comments */

program code two

12-14:对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。

说明:这些语句往往是程序实现某一特定功能的关键,对于维护人员来说,良好的注释帮助更好的理解程序,有时甚至优于看设计文档。

12-15:对于switch语句下的case语句,如果因为特殊情况需要处理完一个case后进入下一个case处理,必须在该case语句处理完、下一个case语句前加上明确的注释。

说明:这样比较清楚程序编写者的意图,有效防止无故遗漏break语句。

示例(注意斜体加粗部分):

case CMD_UP:

ProcessUp();

break;

case CMD_DOWN:

ProcessDown();

break;

case CMD_FWD:

ProcessFwd();

if (...)

{

...

break;

}

else

{

ProcessCFW_B(); // now jump into case CMD_A }

case CMD_A:

ProcessA();

break;

case CMD_B:

ProcessB();

break;

case CMD_C:

ProcessC();

break;

case CMD_D:

ProcessD();

break;

...

?2-1:避免在一行代码或表达式的中间插入注释。

说明:除非必要,不应在代码或表达中间插入注释,否则容易使代码可理解性变差。

?2-2:通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构,使代码成为自注释的。

说明:清晰准确的函数、变量等的命名,可增加代码可读性,并减少不必要的注释。

?2-3:在代码的功能、意图层次上进行注释,提供有用、额外的信息。

说明:注释的目的是解释代码的目的、功能和采用的方法,提供代码以外的信息,帮助读者理解代码,防止没必要的重复注释信息。

示例:如下注释意义不大。

/* if receive_flag is TRUE */

if (receive_flag)

而如下的注释则给出了额外有用的信息。

/* if mtp receive a message from links */

if (receive_flag)

?2-4:在程序块的结束行右方加注释标记,以表明某程序块的结束。

说明:当代码段较长,特别是多重嵌套时,这样做可以使代码更清晰,更便于阅读。

示例:参见如下例子。

if (...)

{

// program code

while (index < MAX_INDEX)

{

// program code

} /* end of while (index < MAX_INDEX) */ // 指明该条while语句结束

} /* end of if (...)*/ // 指明是哪条if语句结束

?2-5:注释格式尽量统一,建议使用“/* …… */”。

?2-6:注释应考虑程序易读及外观排版的因素,使用的语言若是中、英兼有的,建议多使用中文,除非能用非常流利准确的英文表达。

说明:注释语言不统一,影响程序易读性和外观排版,出于对维护人员的考虑,建议使用中文。

3 标识符命名

13-1:标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解。

说明:较短的单词可通过去掉“元音”形成缩写;较长的单词可取单词的头几个字母形成缩写;一些单词有大家公认的缩写。

示例:如下单词的缩写能够被大家基本认可。

temp 可缩写为 tmp ;

flag 可缩写为 flg ;

statistic 可缩写为 stat ;

increment 可缩写为 inc ;

message 可缩写为 msg ;

13-2:命名中若使用特殊约定或缩写,则要有注释说明。

说明:应该在源文件的开始之处,对文件中所使用的缩写或约定,特别是特殊的缩写,进行必要的注释说明。

13-3:自己特有的命名风格,要自始至终保持一致,不可来回变化。

说明:个人的命名风格,在符合所在项目组或产品组的命名规则的前提下,才可使用。(即命名规则中没有规定到的地方才可有个人命名风格)。

13-4:对于变量命名,禁止取单个字符(如i、j、k...),建议除了要有具体含义外,还能表明其变量类型、数据类型等,但i、j、k作局部循环变量是允许的。

说明:变量,尤其是局部变量,如果用单个字符表示,很容易敲错(如i写成j),而编译时又检查不出来,有可能为了这个小小的错误而花费大量的查错时间。

示例:下面所示的局部变量名的定义方法可以借鉴。

int liv_Width

其变量名解释如下:

l 局部变量(Local)(其它:g 全局变量(Global)...)

i 数据类型(Interger)

v 变量(Variable)(其它:c 常量(Const)...)

Width 变量含义

这样可以防止局部变量与全局变量重名。

13-5:命名规范必须与所使用的系统风格保持一致,并在同一项目中统一,比如采用UNIX的全小写加下划线的风格或大小写混排的方式,不要使用大小写与下划线混排的方式,用作特殊标识如标识成员变量或全局变量的m_和g_,其后加上大小写混排的方式是允许的。

示例: Add_User不允许,add_user、AddUser、m_AddUser允许。

?3-1:除非必要,不要用数字或较奇怪的字符来定义标识符。

示例:如下命名,使人产生疑惑。

#define _EXAMPLE_0_TEST_

#define _EXAMPLE_1_TEST_

void set_sls00( BYTE sls );

应改为有意义的单词命名

#define _EXAMPLE_UNIT_TEST_

#define _EXAMPLE_ASSERT_TEST_

void set_udt_msg_sls( BYTE sls );

?3-2:在同一软件产品内,应规划好接口部分标识符(变量、结构、函数及常量)的命名,防止编译、链接时产生冲突。

说明:对接口部分的标识符应该有更严格限制,防止冲突。如可规定接口部分的变量与常量之前加上“模块”标识等。

?3-3:用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。

说明:下面是一些在软件中常用的反义词组。

add / remove begin / end create / destroy

insert / delete first / last get / release

increment / decrement put / get

add / delete lock / unlock open / close

min / max old / new start / stop

next / previous source / target show / hide

send / receive source / destination

cut / paste up / down

示例:

int min_sum;

int max_sum;

int add_user( BYTE *user_name );

int delete_user( BYTE *user_name );

?3-4:除了编译开关/头文件等特殊应用,应避免使用_EXAMPLE_TEST_之类以下划线开始和结尾的定义。

相关文档