C(C)编程规范课程教材注释版.docx
《C(C)编程规范课程教材注释版.docx》由会员分享,可在线阅读,更多相关《C(C)编程规范课程教材注释版.docx(59页珍藏版)》请在得力文库 - 分享文档赚钱的网站上搜索。
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)种方式是应该严格避免和禁止的。第一种方式应用比较多,主要用与代码不是特别复杂的情况。第二种方式主要用于代码结构非常复杂的情况,
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 编程 规范 课程 教材 注释
限制150内