软件编码规范.docx
- 文档编号:7572642
- 上传时间:2023-01-25
- 格式:DOCX
- 页数:41
- 大小:41.98KB
软件编码规范.docx
《软件编码规范.docx》由会员分享,可在线阅读,更多相关《软件编码规范.docx(41页珍藏版)》请在冰豆网上搜索。
软件编码规范
软件编码规范(V1.0)
软件设计更多地是一种工程,而不是一种个人艺术。
如果不统一编程规范,最终写出的程序,其可读性将较差,这不仅给代码的理解带来障碍,增加维护阶段的工作量,同时不规范的代码隐含错误的可能性也比较大。
分析表明,编码阶段产生的错误当中,语法错误大概占20%左右,而由于未严格检查软件逻辑导致的错误、函数(模块)之间的接口错误,以及由于代码可理解度低导致优化维护阶段对代码的错误修改引起的错误则占了一半以上。
可见,提高软件质量必须降低编码阶段的错误率。
如何有效降低编码阶段的错误呢?
这需要制定详细的软件编程规范,并培训每一位程序员,最终的结果可以把编码阶段的错误降至10%左右,同时也降低了程序的测试费用,效果相当显著。
主要从以下几个方面来说明:
(1)排版
(2)注释
(3)标识符命名
(4)可读性
(5)变量与结构
(6)函数与过程
(7)可测性
(8)程序效率
(9)质量保证
(10)代码编辑、编译、审查
(11)代码测试、维护
(12)宏
下面分别来讲述。
一、排版
1.程序块要采用缩进风格编写,缩进的空格数为4个
说明:
对于由开发工具自动生成的代码可以有不一致。
2.相对独立的程序块之间、变量说明之后必须加空行
示例:
如下例子不符合规范。
if(!
valid_ni(ni))
{
inti;
...//programcode
}
repssn_ind=ssn_data[index].repssn_index;
repssn_ni=ssn_data[index].ni;
应如下书写:
if(!
valid_ni(ni))
{
inti;
...//programcode
}
repssn_ind=ssn_data[index].repssn_index;
repssn_ni=ssn_data[index].ni;
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 &&(n7stat_stat_item_valid(stat_item)) &&(act_task_table[taskno].result_data! =0)); 4.循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首 示例: if((taskno &&(n7stat_stat_item_valid(stat_item))) { ...//programcode } for(i=0,j=0;(i &&(j { ...//programcode } for(i=0,j=0; (i i++,j++) { ...//programcode } 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); 6.不允许把多个短语句写在一行中,即一行只写一条语句 示例: 如下例子不符合规范。 rect.length=0;rect.width=0; 应如下书写 rect.length=0; rect.width=0; 7.if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while等语句的执行语句部分无论多少都要加括号{} 示例: 如下例子不符合规范。 if(pUserCR==NULL)return; 应如下书写: if(pUserCR==NULL) { return; } 8.对齐只使用空格键,不使用TAB键 说明: 以免用不同的编辑器阅读程序时,因TAB键所设置的空格数目不同而造成程序布局不整齐,不要使用BC作为编辑器合版本,因为BC会自动将8个空格变为一个TAB键,因此使用BC合入的版本大多会将缩进变乱。 9.函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case语句下的情况处理语句也要遵从语句缩进要求 10.程序块的分界符(如C/C++语言的大括号‘{’和‘}’)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。 在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式 示例: 如下例子不符合规范。 for(...){ ...//programcode } if(...) { ...//programcode } voidexample_fun(void) { ...//programcode } 应如下书写。 for(...) { ...//programcode } if(...) { ...//programcode } voidexample_fun(void) { ...//programcode } 11.在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后不应加空格。 说明: 采用这种松散方式编写代码的目的是使代码更加清晰 由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格,如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为在C/C++语言中括号已经是最清晰的标志了。 在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。 给操作符留空格时不要连续留两个以上空格。 示例: (1)逗号、分号只在后面加空格。 inta,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.一般情况下,源程序有效注释量必须在20%以上 说明: 注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。 2.说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出: 版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明 示例: 下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。 /************************************************* *Copyright(C)2008ChompTech.Co.,Ltd. *Filename: //文件名 *Description: //用于详细说明此程序文件完成的主要功能,与其他模块 *//或函数的接口,输出值、取值范围、含义及参数间的控 *//制、顺序、独立或依赖等关系 *Author: //作者 *Version: //版本 *Date: //完成日期 *************************************************/ 3.函数头部应进行注释,列出: 函数的目的/功能、输入参数、输出参数、返回值 示例: /************************************************* *Function: //函数名称 *Description: //函数功能、性能等的描述 *Input: //输入参数说明,包括每个参数的作 *//用、取值说明及参数间关系。 *Output: //对输出参数的说明。 *Return: //函数返回值的说明 *Others: //其它说明 *************************************************/ 4.边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。 不再有用的注释要删除 5.注释的内容要清楚、明了,含义准确,防止注释二义性 说明: 错误的注释不但无益反而有害。 6.避免在注释中使用缩写 说明: 在使用缩写时或之前,应对缩写进行必要的说明。 7.注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开 示例: 如下例子不符合规范。 例1: /*getreplicatesubsystemindexandnetindicator*/ 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; /*getreplicatesubsystemindexandnetindicator*/ 应如下书写 /*getreplicatesubsystemindexandnetindicator*/ repssn_ind=ssn_data[index].repssn_index; repssn_ni=ssn_data[index].ni; 8.对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义。 变量、常量、宏的注释应放在其上方相邻位置或右方 示例: /*activestatistictasknumber*/ #defineMAX_ACT_TASK_NUMBER1000 #defineMAX_ACT_TASK_NUMBER1000/*activestatistictasknumber*/ 9.数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释。 对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方 示例: 可按如下形式说明枚举/数据/联合结构。 /*sccpinterfacewithsccpuserprimitivemessagename*/ enumSCCP_USER_PRIMITIVE { N_UNITDATA_IND,/*sccpnotifysccpuserunitdatacome*/ N_NOTICE_IND,/*sccpnotifyusertheNo.7networkcannot*/ /*transmissionthismessage*/ N_UNITDATA_REQ,/*sccpuser'sunitdatatransmissionrequest*/ }; 10.全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明 示例: /*TheErrorCodewhenSCCPtranslate*/ /*GlobalTitlefailure,asfollows*///变量作用、含义 /*0-SUCCESS1-GTTableerror*/ /*2-GTerrorOthers-nouse*///变量取值范围 /*onlyfunctionSCCPTranslate()in*/ /*thismodualcanmodifyit,andother*/ /*modulecanvisititthroughcall*/ /*thefunctionGetGTTransErrorCode()*///使用方法 BYTEg_GTTranErrorCode; 11.注释与所描述内容进行同样的缩排 说明: 可使程序排版整齐,并方便注释的阅读与理解。 示例: 如下例子,排版不整齐,阅读稍感不方便。 voidexample_fun(void) { /*codeonecomments*/ CodeBlockOne /*codetwocomments*/ CodeBlockTwo } 应改为如下布局。 voidexample_fun(void) { /*codeonecomments*/ CodeBlockOne /*codetwocomments*/ CodeBlockTwo } 12.对变量的定义和分支语句(条件分支、循环语句等)必须编写注释 说明: 这些语句往往是程序实现某一特定功能的关键,对于维护人员来说,良好的注释帮助更好的理解程序,有时甚至优于看设计文档。 13.对于switch语句下的case语句,如果因为特殊情况需要处理完一个case后进入下一个case处理,必须在该case语句处理完、下一个case语句前加上明确的注释 说明: 这样比较清楚程序编写者的意图,有效防止无故遗漏break语句。 示例(注意斜体加粗部分): caseCMD_UP: ProcessUp(); break; caseCMD_DOWN: ProcessDown(); break; caseCMD_FWD: ProcessFwd(); if(...) { ... break; } else { ProcessCFW_B();//nowjumpintocaseCMD_A } caseCMD_A: ProcessA(); break; caseCMD_B: ProcessB(); break; caseCMD_C: ProcessC(); break; caseCMD_D: ProcessD(); break; ... 14.避免在一行代码或表达式的中间插入注释 说明: 除非必要,不应在代码或表达中间插入注释,否则容易使代码可理解性变差。 15.在程序块的结束行右方加注释标记,以表明某程序块的结束 说明: 当代码段较长,特别是多重嵌套时,这样做可以使代码更清晰,更便于阅读。 示例: 参见如下例子。 if(...) { //programcode while(index { //programcode }/*endofwhile(index }/*endofif(...)*///指明是哪条if语句结束 16.注释应考虑程序易读及外观排版的因素,使用的语言若是中、英兼有的,建议多使用中文,除非能用非常流利准确的英文表达 说明: 注释语言不统一,影响程序易读性和外观排版,出于对维护人员的考虑,建议使用中文。 三、标识符命名 1: 标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解 说明: 较短的单词可通过去掉“元音”形成缩写;较长的单词可取单词的头几个字母形成缩写;一些单词有大家公认的缩写。 示例: 如下单词的缩写能够被大家基本认可。 temp可缩写为tmp; flag可缩写为flg; statistic可缩写为stat; message可缩写为msg; 2.命名中若使用特殊约定或缩写,则要有注释说明 说明: 应该在源文件的开始之处,对文件中所使用的缩写或约定,特别是特殊的缩写,进行必要的注释说明。 3.自己特有的命名风格,要自始至终保持一致,不可来回变化 说明: 个人的命名风格,在符合所在项目组或产品组的命名规则的前提下,才可使用。 (即命名规则中没有规定到的地方才可有个人命名风格)。 4.对于变量命名,禁止取单个字符(如i、j、k...),建议除了要有具体含义外,还能表明其变量类型、数据类型等,但i、j、k作局部循环变量是允许的 说明: 变量,尤其是局部变量,如果用单个字符表示,很容易敲错(如i写成j),而编译时又检查不出来,有可能为了这个小小的错误而花费大量的查错时间。 示例: 下面所示的局部变量名的定义方法可以借鉴。 intliv_Width 其变量名解释如下: l局部变量(Local)(其它: g全局变量(Global)...) i数据类型(Interger) v变量(Variable)(其它: c常量(Const)...) Width变量含义 这样可以防止局部变量与全局变量重名。 5.命名规范必须与所使用的系统风格保持一致,并在同一项目中统一 (1)除非必要,不要用数字或较奇怪的字符来定义标识符 示例: 如下命名,使人产生疑惑。 #define_EXAMPLE_0_TEST_ #define_EXAMPLE_1_TEST_ voidset_sls00(BYTEsls); 应改为有意义的单词命名 #define_EXAMPLE_UNIT_TEST_ #define_EXAMPLE_ASSERT_TEST_ voidset_udt_msg_sls(BYTEsls); (2)在同一软件产品内,应规划好接口部分标识符(变量、结构、函数及常量)的命名,防止编译、链接时产生冲突 说明: 对接口部分的标识符应该有更严格限制,防止冲突。 如可规定接口部分的变量与常量之前加上“模块”标识等。 (3)用正确的反义词组命名具有互斥意义的变量或相反动作的函数等 说明: 下面是一些在软件中常用的反义词组。 add/removebegin/endcreate/destroy insert/deletefirst/lastget/release increment/decrementput/get add/deletelock/unlockopen/close min/maxold/newstart/stop next/previoussource/targetshow/hide send/receivesource/destination cut/pasteup/down 示例: intmin_sum; intmax_sum; intadd_user(BYTE*user_name); intdelete_user(BYTE*user_name); (4)除了编译开关/头文件等特殊应用,应避免使用_EXAMPLE_TEST_之类以下划线开始和结尾的定义 四、可读性 1.注意运算符的优先级,并用括号明确表达式的操作顺序,避免使用默认优先级 说明: 防止阅读程序时产生误解,防止因默认的优先级与设计思想不符而导致程序出错。 示例: 下列语句中的表达式 word=(high<<8)|low (1) if((a|b)&&(a&c)) (2) if((a|b)<(c&d))(3) 如果书写为: high<<8|low a|b&&a&c a|b 由于 high<<8|low=(high<<8)|low, a|b&&a&c=(a|b)&&(a&c), (1) (2)不会出错,但语句不易理解; a|b 2.避免使用不易理解的数字,用有意义的标识来替代。 涉及物理状态或者含有物理意义的常量,不应直接使用数字,必须用有意义的枚举或宏来代替 示例: 如下的程序可读性差。 if(Trunk[index].trunk_state==0) { Trunk[index].trunk_state=1; ...//programcode } 应改为如下形式。 #defineTRUNK_IDLE0 #defineTRUNK_BUSY1 if(Trunk[index].trunk_state==TRUNK_IDLE) { Trunk[index]
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 软件 编码 规范
![提示](https://static.bdocx.com/images/bang_tan.gif)