《C(C)编程规范课程教材注释版.docx》由会员分享，可在线阅读，更多相关《C(C)编程规范课程教材注释版.docx（59页珍藏版）》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、内部资料,注意保密编程规范教材前言软件编程规范总则3第一章排版4第二章注释10第三章标识符命名17第四章可读性20第五章变量、结构23第六章函数、过程30第七章可测性40第八章程序效率45第九章质量保证50第十章代码编辑、编译、审查57第十一章代码测试、维护59第十二章宏61前舌软件编程规范总则为了提高源程序的质量和可维护性,最终提高公司软件产品生产,我们有必要对公司 软件产品的源程序的编写风格作出统的规范约束。本规范总则是独立于具体语言的编程规则的总的原则,针对不同编程语言或应用环境的 编程规范在遵守本规范总则的基础上,还必须遵守相应语言和就用环境的编程规范。本 规范总则适用于公司所有产品以
2、及对外合作委托开发产品的软件源程序。本规范总则的内容包括:排版、注释、标识符命名、变量使用、代码可测性、程序效率、 质量保证、代码编译、单元测试、程序版本与维护等。本规范总则的示例都以C语言为背景,采用以下的术语描述: 规则:编程时强制必须遵守的原则。 建议:编程时必须加以考虑的原则。 说明：对此规则或建议进行必要的解释。 示例：对此规则或建议从正、反两个方面给出例子。第一章排版1-1:程序块要采用缩进风格编写,缩进的空格数为4个。说明:对于由开发工具自动生成的代码可以有不一致。 唯一例外的是编译开关和宏定义。如下各举个例子： 编译开关例子:int SendMsg(EXEC_MSG* pMsg
3、)#ifdef _UNT_DEBUG DoTe /Z函数其它代码1-2：相对独立的程序块之间、变量说明之后必须加空行。示例:如下例子不符合规范。if (!valid_ni(ni)(./ program codere;应如下书写if (!valid_ni(ni) Z/ program codere;re;空行可以使程序结构比较清晰。逻辑上关系比较紧密的代码放在起,逻辑上相对比较独立的 部分用空行隔开。1-3:较长的语句(80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作 符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。示例:perm_count_msg.he
4、ad.len = NO7_TO_STAT_PERM_COUNT_LEN+ STAT_SIZE_PER_FRAM * sizeof( _UL );act_task_tableframe_id * STAT_TASK_CHECK_NUMBER + index.occupied = stat_poiindex.occupied;act_task_tabletaskno.duration_true_or_false= SYS_get_sccp_statistic_state ( stat_item );report_or_not_flag = (taskno MAX_ACT_TASK_NUMBER)
5、& (n7stat_stat_item_valid (stat_item) & (act_task_tabletaskno.result_data != 0)；长语句分多行书写比较美观。在低优先级操作符处划分新行,可使每一行具有相当独立而完整的含义,从而比较清晰。折行时,操作符要放行首。1-4；循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先 级操作符处划分新行,操作符放在新行之首。示例:if (taskno max_act_task_number)& (n7stat_stat_item_valid (stat_item)( Z/ program codefor
6、 (i = 0, j = 0; (i BufferKeywordword_index.word_length)& (j NewKeyword.word_length); i+, j+)( Z/ program codefor (i = 0, j = 0;(i first_word_length) & (j for% do、whiles case、switch、default等语句自占一行,且if、for、do、 while等语句的执行语句部分无论多少都要加括号 示例:如下例子不符合规范。if (pUserCR = NULL) return;应如下书写:if (pUserCR = NULL) r
7、eturn;关键字独占一行是为了使程序结构清晰可读。if、for do while等语句的执行语句部分无论多少都要加括号。,下面的例子来解释原 因:如果写成:if (pUserCR = NULL) return;以后的测试中发现这种条件满足时,还要做些其它处理,比如要写日志,那么很容易就写成 了下面的语句:if (pUserCR = NULL)WriteLog(* Invalid UserCR *);return;写成这样就大错特错了,不管pUserCR是否为NULL,程序都会执行到return语句,造成逻 辑错误。为了避免这样的问题,因此要求if、for, do. while的执行语句,不管
8、有多少, 都要用 括起来。1-8:对齐只使用空格键,不使用TAB键。说明:以免用不同的编辑器阅读程序时,因TAB键所设置的空格数目不同而造成程序布局不整 齐,不要使用BC作为编辑器合版本,因为BC会自动将8个空格变为个TAB键,因此使用BC 合入的版本大多会将缩进变乱。目前大多数的编程工具都提供奖TAB键和成空格键。1-9:函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case语句 下的情况处理语句也要遵从语句缩进要求。对于case语句的缩进说明如下:如果case语句中不需定义新的变量,则为:switch (pMsg-iMsgType)(case EXEJMSG:On
9、ExecMsg(pMsg);break;ZZ其它case处理语句如果case语句中需要定义新的变量,则必须用括起来,缩进为:switch (pMsg-iMsgType)(case EXEC_MSG:(DWORD dwDataLen = pMsg-dwMemLen - sizeof(MSG_HEAD);OnExecMsg(pMsg, dwDataLen);break;case SHAKE_HAND_MSG:|1-10:程序块的分界符(如C/C+语言的大括号和)应各独占一行并且位于同一列, 同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for. do、whi
10、le、switch, case语句中的程序都要采用如上的缩进方式。示例:如下例子不符合规范。for ()( Z/ program codeif (.)( Z/ program code)void example_fun( void )(. / program code应如下书写。for () Z/ program codeif (.) Z/ program codevoid example_fun( void )( Z/ program code在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前 后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如一),后不
11、应加空格。说明:采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格,如 果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必 加空格，因为在C/C+语言中括号已经是最清晰的标志了。在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作 符留空格时不要连续留两个以上空格。示例:(1)逗号、分号只在后面加空格。 int a, b, c;(2)比较操作符,赋值操作符、+=算术操作符+逻辑操作符&、&,位域操作符= MAX_TIME_VALUE) a = b + c;
12、a = 2;a = b A 2;(3) !、+、一、&(地址运算符)等单目操作符前后不加空格。*p = a;/内容操作*与内容之间flag = lisEmpty; /非操作！与内容之间 p = &mem;/Z地址操作,&与内容之间i+;/与内容之间(4)，、，.，前后不加空格。p-id = pid; /指针前后不加空格(5) if、for、while、switch等与后面的括号间应加空格,使if等关键字更为突出、明 显。 if (a = b & c d)1-1: 一行程序以小于80字符为宜,不要写得过长。第二章注释2-1: 一般情况下,源程序有效注释量必须在20%以上。说明:注释的原则是有助于
13、对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太 少，注释语言必须准确、易懂、简洁。20%的标准要求不高，因为文件头部的注释，函数头部的注释就占了很大的比例。因此达到 20%注释量,对实际语句的注释量要求不高。2-2：说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行 注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修 改日志等,头文件的注释中还应有函数功能简要说明。示例:下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含 在内。Copyright (C), 19881999, H
14、uawei Tech. Co.r Ltd.File name:/Z 文件名Author:Version:Date : /作者、版本及完成日期Description:/Z用于详细说明此程序文件完成的主要功能,与其他模块/Z或函数的接口,输出值、取值范围、含义及参数间的控/制、顺序、独立或依赖等关系Others:/Z其它内容的说明Function LiHistory:/Z修改历史记录列表,每条修改记录应包括修改日期、修改/者及修改内容简述1. Date:Author:Modification: 2. ,目前各种编辑器都提供宏的功能,通过宏功能可以方便的生成函数头，文件头的格式化注释。2-3：源文件
15、头部应进行注释，列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要 函数及其功能、修改日志等。示例：下面这段源文件的头注释比较标准,当然，并不局限于此格式，但上述信息建议要包含 在内。/*夫*Copyright （C）, 19881999, Huawei Tech. Co., Ltd.FileName: test.cppAuthor:Version :Date:Description:/Z 模块描述Version:/Z版本信息Function Libuild this moudle说明:Description项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它 文件关系等。H
16、istory是修改历史记录列表,每条修改记录应包括修改日期、修改者及修改 内容简述。2-4Z函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系（函 数、表）等。示例：下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。/*Function :/Z函数名称Description:/Z函数功能、性能等的描述Calls:/Z被本函数调用的函数清单Called By:/Z调用本函数的函数清单Table Accessed: /Z被访问的表（此项仅对于牵扯到数据库操作的程序）Table Updated: /Z被修改的表（此项仅对于牵扯到数据库操作的程
17、序）Input:/Z输入参数说明,包括每个参数的作/Z用、取值说明及参数间关系。Output:/Z对输出参数的说明。Return:/Z函数返回值的说明Others :/Z其它说明2-5:边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的 注释要删除。/先检查参数,看是否满足可执行Sql实际编程过程中，代码与注释的书写关系有三种:1）先写一行代码,然后马上写注释,也即边写代码边写注释2）先写注释,再写代码3）先把代码全写完了,再补注释。第3）种方式是应该严格避免和禁止的。第一种方式应用比较多,主要用与代码不是特别复杂的情况。第二种方式主要用于代码结构非常复杂的情况,
18、举例如下:short ExecSql（PARAM_LIST* pParamList, char* pUserName, char* pPa;re;例2: re; re;/* get replicate sub system index and net indicator */应如下书写/* get replicate sub system index and net indicator */ re;re;2-9j对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注 释,说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。示例:/* active stat
19、istic task number */#define MAX_ACT_TASK_NUMBER 1000#define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */2-10:数据结构声明（包括数组、结构、类、枚举等），如果其命名不是充分自注释的,必须加以 注释.对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此 域的右方。示例:可按如下形式说明枚举/数据/联合结构。/* seep interface with seep user primitive message name */enum S
20、CCP_USER_PRIMITIVE N_UNITDATA_INDZ /* seep notify seep user unit data come */N_NOTCE_ND, /* seep notify user the No. 7 network can not */* transmission this message */N_UN1TDATA_REQ, /* seep user * s unit data transmission request*/；对结构,类,枚举,联合必须对每项进行注释,这一点请参见主机分则。2-11:全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或
21、过程存取它以及存取时 注意事项等的说明。示例:/* The ErrorCode when SCCP translate /* Global Title failure, as follows */ /Z 变量作用、含义/* 0 SUCCESS 1 GT Table error */* 2 GT error Others - no use */ /Z 变量取值范围/* only function SCCPTranslate () in */ /* this modual can modify it, and other */ /* module can visit it through call
22、 / the function GetGTTransErrorCode () */ 使用方法BYTE g_GTTranErrorCode;2-12Z注释与所描述内容进行同样的缩排。说明:可使程序排版整齐,并方便注释的阅读与理解。示例:如下例子,排版不整齐,阅读稍感不方便。 void example_fun( void ) ( /* code one comments */CodeBlock One/* code two comments */ CodeBlock Two 应改为如下布局。void example_fun( void ) /* code one comments */ CodeB
23、lock One/* code two comments */ CodeBlock Two2-13：将注释与其上面的代码用空行隔开。示例:如下例子,显得代码过于紧凑。/* code one comments */ program code one/* code two comments */ program code two应如下书写/* code one comments */ program code one/* code two comments */ program code two2-14:对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。说明：这些语句往往是程序实现某特定
24、功能的关键,对于维护人员来说,良好的注释帮助更 好的理解程序,有时甚至优于看设计文档。变量的定义,如果不是充分自注释的,必须注释,写明其用途，取值范围等。if, for, while, switch 必须口注释。2-15：对于switch语句下的case语句,如果因为特殊情况需要处理完一个case后进入下个 case处理,必须在该case语句处理完、下个case语句前加上明确的注释。说明:这样比较清楚程序编写者的意图,有效防止无故遗漏break语句。示例(注意斜体加粗部分)：case CMD_UP:ProcessUp();break;case CMD_DOWN:ProcessDown();br
25、eak;case CMD_FWD:Proce(break;elseProcessCFW_B ;/ now jump into case CMD_Acase CMD_A:ProcessA();break;case CMD_B:ProcessB();break;case CMD_C:ProcessC ();break;case CMD_D:ProcessD();break;2-1:避免在一行代码或表达式的中间插入注释。说明:除非必要,不应在代码或表达中间插入注释,否则容易使代码可理解性变差。2-2:通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构,使代 码成为自注释的。说明:清晰准
26、确的函数、变量等的命名,可增加代码可读性,并减少不必要的注释。2-3:在代码的功能、意图层次上进行注释,提供有用、额外的信息。说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理 解代码，防止没必要的重复注释信息。示例:如下注释意义不大。/* if receive_flag is TRUE */if (receive_flag)而如下的注释则给出了额外有用的信息。/* if mtp receive a message from links */if (receive_flag)必须在代码的实际逻辑含义的层次上进行注释,这样的注释是有效的注释。否则就失去了注 释的作
27、用。22-4:在程序块的结束行右方加注释标记,以表明某程序块的结束。说明:当代码段较长,特别是多重嵌套时,这样做可以使代码更清晰,更便于阅读。示例:参见如下例子。if ()(/ program codewhile (index MAX_INDEX) (/ program code /* end of while (index AddUser m_AddUser允许。3-1:除非必要,不要用数字或较奇怪的字符来定义标识符。示例:如下命名,使人产生疑惑。#define _EXAMPLE_O_TEST_# define _EXAMPLE_1_TEST_ void set-slsOO ( BYTE s
28、is );应改为有意义的单词命名# define _EXAMPLE_UNT_TEST_# define _EXAMPLE_ASSERT_TEST_ void set_udt_msg_s 1 s ( BYTE sis );3-2:在同一软件产品内,应规划好接口部分标识符(变量、结构、函数及常量)的命 名,防止编译、链接时产生冲突。说明:对接口部分的标识符应该有更严格限制,防止冲突。如可规定接口部分的变量与常量之 前加上“模块”标识等。3-3i用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。说明:下面是些在软件中常用的反义词组。add / removebegin / endinsert
29、/ delete first / last increment / decrementadd / deletelock / unlockmin / maxold / newnext / previous source / targetcreate / destroy get / release put / getopen / closestart / stop show / hidesend / receive source / destinationcut / pasteup / down示例:int min_sum;int max_sum;int add_user ( BYTE * use
30、 rename );int delete_user( BYTE *user_name );3-4:除了编译开关/头文件等特殊应用,应避免使用.EXAMPLE_TEST_之类以下划线 开始和结尾的定义。编译开关一定要以下划线开头。第四章可读性4-1:注意运算符的优先级,并用括号明确表达式的操作顺序,避免使用默认优先级。说明:防止阅读程序时产生误解,防止因默认的优先级与设计思想不符而导致程序出错。示例：下列语句中的表达式word = (high 8) | low (1) if ( (a I b) & (a & c) )(2)if ( (a I b) (c & d) )(3)如果书写为 high 8
31、 I low a I b & a & c a I b c & d 由于high 8 | low = ( high 8) | lowz a I b & & a & c = (a I b) & (a & c), (1)(2)不会出错,但语句不易理解;a|bc&d = a| (b Input_Rec、Print_Rec、Stat_Score为 四个不同的函数;Student- Score为两个全局变量;Create表示创建，Modify表示修改, Access表示访问其中,函数Input_Rec、Stat_Score都可修改变量Score,故此变量将引起函数间较大的 耦合，并可能增加代码测试、维护的
32、难度。5-4：当向公共变量传递数据时,要十分小心,防止赋与不合理的值或越界等现象发生。说明:对公共变量赋值时，若有必要应进行合法性检查，以提高代码的可靠性、稳定性。5-5:防止局部变量与公共变量同名。说明:若使用了较好的命名规则,那么此问题可自动消除。局部变量不允许与公共变量同名。C+ +中，由于表示一个作用域，因此在个函数内部的中定义的变量是可以与此外的 变量重名的，但二者作用域不同。我们的编码中不允许这种情况出现，除非特殊需要。5-6:严禁使用未经初始化的变量作为右值。说明:特别是在C/C+中引用未经赋值的指针，经常会引起系统崩溃。不同的编译器对变量的默认初始化是不同的。为了避免不同编译器
33、引起的差别，对变量，尤其是指针变量,强烈推荐在使用前将其初始化。5-1:构造仅有一个模块或函数可以修改、创建,而其余有关模块或函数只访问的公共 变量,防止多个不同模块或函数都可以修改、创建同一公共变量的现象。说明:降低公共变量耦合度。5-2:使用严格形式定义的、可移植的数据类型,尽量不要使用与具体硬件或软件环境 关系密切的变量。说明:使用标准的数据类型,有利于程序的移植。比如布尔类型不要乱用 示例：如下例子(在DOS下BC3.1环境中),在移植时可能产生问题。void main() (register int index; / 寄存器变量_AX = 0x4000; / 一AX是BC3.1提供的
34、寄存器“伪变量” Z/ program code 5-3:结构的功能要单,是针对种事务的抽象。说明：设计结构时应力争使结构代表种现实事务的抽象,而不是同时代表多种。结构中的各 元素应代表同一事务的不同侧面，而不应把描述没有关系或关系很弱的不同事务的元素放到同 一结构中。示例：如下结构不太清晰、合理。typedef struct STUDENT_STRU (unsigned char name8; /* student1s name */unsigned char age;/* student * s age */unsigned char sex;/* student1s sex, as follows */* 0 - FEMALE