华为C语言编程规范总则.pdf
![资源得分’ title=](/images/score_1.gif)
![资源得分’ title=](/images/score_1.gif)
![资源得分’ title=](/images/score_1.gif)
![资源得分’ title=](/images/score_1.gif)
![资源得分’ title=](/images/score_05.gif)
《华为C语言编程规范总则.pdf》由会员分享,可在线阅读,更多相关《华为C语言编程规范总则.pdf(31页珍藏版)》请在淘文阁 - 分享文档赚钱的网站上搜索。
1、-1-编程规范总则编程规范总则 编程规范总则 1 1 排版 1 2 注释 3 3 标识符命名 7 4 可读性 9 5 变量、结构 10 6 函数、过程 14 7 程序效率 19 8 质量保证 23 9 代码编辑、编译、审查 28 10 代码测试、维护 29 11 宏 30 1 排版排版 1-1:程序块要采用缩进风格编写,缩进的空格数为:程序块要采用缩进风格编写,缩进的空格数为 4 个。个。说明:对于由开发工具自动生成的代码可以有不一致。1-2:相对独立的程序块之间、变量说明之后必须加空行。:相对独立的程序块之间、变量说明之后必须加空行。示例:如下例子不符合规范。if(!valid_ni(ni)
2、./program code repssn_ind=ssn_dataindex.repssn_index;repssn_ni =ssn_dataindex.ni;应如下书写 if(!valid_ni(ni)./program code repssn_ind=ssn_dataindex.repssn_index;repssn_ni =ssn_dataindex.ni;Generated by Foxit PDF Creator Foxit Softwarehttp:/ For evaluation only.-2-1-3:较长的语句(:较长的语句(80 字符)要分成多行书写,长表达式要在低优先级
3、操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。示例:perm_count_msg.head.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_tabletask
4、no.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_tabletaskno.result_data!=0);1-4:不允许把多个短语句写在一行中,即一行只写一条语句。:不允许把多个短语句写在一行中,即一行只写一条语句。示例:如下例子不符合规范。rect.length=0;rect.width=0;应如下书写 rect.length
5、=0;rect.width =0;1-5:if、for、do、while、case、switch、default 等语句自占一行,且等语句自占一行,且 if、for、do、while等语句的执行语句部分无论多少都要加括号等语句的执行语句部分无论多少都要加括号。示例:如下例子不符合规范。if(pUserCR=NULL)return;应如下书写:if(pUserCR=NULL)return;1-6:对齐只使用空格键,不使用:对齐只使用空格键,不使用 TAB 键。键。说明:以免用不同的编辑器阅读程序时,因 TAB 键所设置的空格数目不同而造成程序布局不整齐,不要使用 BC 作为编辑器合版本,因为 B
6、C 会自动将 8 个空格变为一个 TAB 键,因此使用 BC 合入的版本大多会将缩进变乱。1-7:函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,:函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case语句下的情况处理语句也要遵从语句缩进要求。语句下的情况处理语句也要遵从语句缩进要求。1-8:程序块的分界符(如:程序块的分界符(如 C/C+语言的大括号语言的大括号和和)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体的开
7、始、类的定义、结构的定义、枚举的定义以及 if、for、do、while、switch、case 语句中的程序都要采用如上的缩进方式。语句中的程序都要采用如上的缩进方式。Generated by Foxit PDF Creator Foxit Softwarehttp:/ For evaluation only.-3-示例:如下例子不符合规范。for(.)./program code if(.)./program code void example_fun(void)./program code 应如下书写。for(.)./program code if(.)./program code vo
8、id example_fun(void)./program code 1-9:一行程序以小于:一行程序以小于 80 字符为宜,不要写得过长。字符为宜,不要写得过长。2 注释注释 2-1:一般情况下,源程序有效注释量必须在:一般情况下,源程序有效注释量必须在 20以上。以上。说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。2-2:文件头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、修改日志等。:文件头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、修改日志等。示例:下面这段头
9、文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。Generated by Foxit PDF Creator Foxit Softwarehttp:/ For evaluation only.-4-/*Copyright:1988-1999,Huawei Tech.Co.,Ltd.File name:文件名 Description:用于详细说明此程序文件完成的主要功能,与其他模块或函数的接口,输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系 Author:作者 Version:版本 Date:完成日期 History:修 改 历 史 记 录 列 表,每 条
10、修 改 记 录 应 包 括 修 改 日 期、修 改 者及修改内容简述。*/2-3:函数头部应进行注释,列出:函数的目的:函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。功能、输入参数、输出参数、返回值、调用关系(函数、表)等。示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。/*Function:/函数名称 Description:/函数功能、性能等的描述 Calls:/被本函数调用的函数清单 Called By:/调用本函数的函数清单 Table Accessed:/被访问的表(此项仅对于牵扯到数据库操作的程序
11、)Table Updated:/被修改的表(此项仅对于牵扯到数据库操作的程序)Input:/输入参数说明,包括每个参数的作 /用、取值说明及参数间关系。Output:/对输出参数的说明。Return:/函数返回值的说明 Others:/其它说明*/2-4:边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。:边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。2-5:注释的内容要清楚、明了,含义准确,防止注释二义性。:注释的内容要清楚、明了,含义准确,防止注释二义性。说明:错误的注释不但无益反而有害。2-6:注释应
12、与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。:注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。示例:如下例子不符合规范。例 1:/*get replicate sub system index and net indicator*/repssn_ind=ssn_dataindex.repssn_index;Generated by Foxit PDF Creator Foxit Softwarehttp:/ For
13、 evaluation only.-5-repssn_ni=ssn_dataindex.ni;例 2:repssn_ind=ssn_dataindex.repssn_index;repssn_ni=ssn_dataindex.ni;/*get replicate sub system index and net indicator*/应如下书写/*get replicate sub system index and net indicator*/repssn_ind=ssn_dataindex.repssn_index;repssn_ni=ssn_dataindex.ni;2-7:对于所有有物
14、理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。:对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。示例:/*active statistic task number*/#define MAX_ACT_TASK_NUMBER 1000#define MAX_ACT_TASK_NUMBER 1000/*active statistic task number*/2-8:数据结构声明:数据结构声明(包括数组、结构、
15、类、枚举等包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。,如果其命名不是充分自注释的,必须加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。示例:可按如下形式说明枚举/数据/联合结构。/*sccp interface with sccp user primitive message name*/enum SCCP_USER_PRIMITIVE N_UNITDATA_IND,/*sccp notify sccp user unit
16、data come*/N_NOTICE_IND,/*sccp notify user the No.7 network can not*/*transmission this message*/N_UNITDATA_REQ,/*sccp users unit data transmission request*/;2-9:全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。:全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。示例:/*The ErrorCode when SCCP translate*
17、/*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;Generated by Foxit PD
18、F Creator Foxit Softwarehttp:/ For evaluation only.-6-2-10:注释与所描述内容进行同样的缩排。:注释与所描述内容进行同样的缩排。说明:可使程序排版整齐,并方便注释的阅读与理解。示例:如下例子,排版不整齐,阅读稍感不方便。void example_fun(void)/*code one comments*/CodeBlock One /*code two comments*/CodeBlock Two 应改为如下布局。void example_fun(void)/*code one comments*/CodeBlock One /*cod
19、e two comments*/CodeBlock Two 2-11:避免在一行代码或表达式的中间插入注释。:避免在一行代码或表达式的中间插入注释。说明:除非必要,不应在代码或表达中间插入注释,否则容易使代码可理解性变差。2-12:通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构,使代码成为自注释的。:通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构,使代码成为自注释的。说明:清晰准确的函数、变量等的命名,可增加代码可读性,并减少不必要的注释。2-13:在代码的功能、意图层次上进行注释,提供有用、额外的信息。:在代码的功能、意图层次上进行注释,提供有用、额外的信
20、息。说明:注释的目的是解释代码的目的、功能和采用的方法,提供代码以外的信息,帮助读者理解代码,防止没必要的重复注释信息。示例:如下注释意义不大。/*if receive_flag is TRUE*/if(receive_flag)而如下的注释则给出了额外有用的信息。/*if mtp receive a message from links*/if(receive_flag)2-14:在程序块的结束行右方加注释标记,以表明某程序块的结束。:在程序块的结束行右方加注释标记,以表明某程序块的结束。说明:当代码段较长,特别是多重嵌套时,这样做可以使代码更清晰,更便于阅读。示例:参见如下例子。if(.)
21、Generated by Foxit PDF Creator Foxit Softwarehttp:/ For evaluation only.-7-/program code while(index MAX_INDEX)/program code /*end of while(index MAX_INDEX)*/指明该条 while 语句结束 /*end of if(.)*/指明是哪条 if 语句结束 2-15:注释格式尽量统一,建议使用“:注释格式尽量统一,建议使用“/*/”。”。2-16:注释应考虑程序易读及外观排版的因素,使用的语言若是中、英兼有的,建议多使用中文,除非能用非常流利准确
22、的英文表达。:注释应考虑程序易读及外观排版的因素,使用的语言若是中、英兼有的,建议多使用中文,除非能用非常流利准确的英文表达。说明:注释语言不统一,影响程序易读性和外观排版,出于对维护人员的考虑,建议使用中文。3 标识符命名标识符命名 3-1:标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解。:标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解。说明:较短的单词可通过去掉“元音”形成缩写;较长的单词可取单词的头几个字母形成缩写;一些单词有大家公认的缩写。示例:如下单词的缩写能够被大家基本认可。te
23、mp 可缩写为 tmp ;flag 可缩写为 flg ;statistic 可缩写为 stat;increment 可缩写为 inc ;message 可缩写为 msg ;3-2:命名中若使用特殊约定或缩写,则要有注释说明。:命名中若使用特殊约定或缩写,则要有注释说明。说明:应该在源文件的开始之处,对文件中所使用的缩写或约定,特别是特殊的缩写,进行必要的注释说明。3-3:自己特有的命名风格,要自始至终保持一致,不可来回变化。:自己特有的命名风格,要自始至终保持一致,不可来回变化。说明:个人的命名风格,在符合所在项目组或产品组的命名规则的前提下,才可使用。(即命名规则中没有规定到的地方才可有个人
24、命名风格)。3-4:对于变量命名,禁止取单个字符(如:对于变量命名,禁止取单个字符(如 i、j、k.),建议除了要有具体含义外,还能表明其变量类型、数据类型等,但),建议除了要有具体含义外,还能表明其变量类型、数据类型等,但 i、j、k 作局部循环变量是允许的。作局部循环变量是允许的。说明:变量,尤其是局部变量,如果用单个字符表示,很容易敲错(如 i 写成 j),而编译时又检查不出来,有可能为了这个小小的错误而花费大量的查错时间。示例:下面所示的局部变量名的定义方法可以借鉴。Generated by Foxit PDF Creator Foxit Softwarehttp:/ For eval
25、uation only.-8-int liv_Width 其变量名解释如下:l 局部变量(Local)(其它:g 全局变量(Global).)i 数据类型(Interger)v 变量(Variable)(其它:c 常量(Const).)Width 变量含义 这样可以防止局部变量与全局变量重名。3-5:命名规范必须与所使用的系统风格保持一致,并在同一项目中统一,比如采用:命名规范必须与所使用的系统风格保持一致,并在同一项目中统一,比如采用 UNIX的全小写加下划线的风格或大小写混排的方式,不要使用大小写与下划线混排的方式,用作特殊标识如标识成员变量或全局变量的的全小写加下划线的风格或大小写混排的
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 华为 语言 编程 规范 总则
![提示](https://www.taowenge.com/images/bang_tan.gif)
限制150内