华为软件编程规范和范例A

第1页目目目目录录录录1排版22注释63标识符命名124可读性145变量、结构166函数、过程227可测性298程序效率339质量保证3710代码编辑、编译、审查4211代码测试、维护4312宏44第2页1111排版排版排版排版1-11-11-11-1：程序块要采用缩进风格编写，缩进的空格数为4444个。说明：对于由开发工具自动生成的代码可以有不一致。1-21-21-21-2：相对独立的程序块之间、变量说明之后必须加空行。示例：如下例子不符合规范。if(!valid_ni(ni)){...//programcode}repssn_ind=ssn_data[index].repssn_index;repssn_ni=ssn_data[index].ni;应如下书写if(!valid_ni(ni)){...//programcode}repssn_ind=ssn_data[index].repssn_index;repssn_ni=ssn_data[index].ni;1-31-31-31-3：较长的语句（80808080字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。示例：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=((tasknoMAX_ACT_TASK_NUMBER)&&(n7stat_stat_item_valid(stat_item))&&(act_task_table[taskno].result_data!=0));第3页1-41-41-41-4：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。示例：if((tasknomax_act_task_number)&&(n7stat_stat_item_valid(stat_item))){...//programcode}for(i=0,j=0;(iBufferKeyword[word_index].word_length)&&(jNewKeyword.word_length);i++,j++){...//programcode}for(i=0,j=0;(ifirst_word_length)&&(jsecond_word_length);i++,j++){...//programcode}1-51-51-51-5：若函数或过程中的参数较长，则要进行适当的划分。示例：stat_str_compare((BYTE*)&stat_object,(BYTE*)&(act_task_table[taskno].stat_object),sizeof(_STAT_OBJECT));stat_flash_act_duration(stat_item,frame_id*STAT_TASK_CHECK_NUMBER+index,stat_object);1-61-61-61-6：不允许把多个短语句写在一行中，即一行只写一条语句。示例：如下例子不符合规范。rect.length=0;rect.width=0;应如下书写rect.length=0;rect.width=0;1-71-71-71-7：ifififif、forforforfor、dodododo、whilewhilewhilewhile、casecasecasecase、switchswitchswitchswitch、defaultdefaultdefaultdefault等语句自占一行，且ifififif、forforforfor、dodododo、whilewhilewhilewhile等语句的执行语句部分无论多少都要加括号{}{}{}{}。示例：如下例子不符合规范。if(pUserCR==NULL)return;应如下书写：if(pUserCR==NULL){第4页return;}1-81-81-81-8：对齐只使用空格键，不使用TABTABTABTAB键。说明：以免用不同的编辑器阅读程序时，因TAB键所设置的空格数目不同而造成程序布局不整齐，不要使用BC作为编辑器合版本，因为BC会自动将8个空格变为一个TAB键，因此使用BC合入的版本大多会将缩进变乱。1-91-91-91-9：函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，casecasecasecase语句下的情况处理语句也要遵从语句缩进要求。1-101-101-101-10：程序块的分界符（如C/C++C/C++C/C++C/C++语言的大括号‘‘‘‘{{{{’’’’和‘‘‘‘}}}}’’’’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及ifififif、forforforfor、dodododo、whilewhilewhilewhile、switchswitchswitchswitch、casecasecasecase语句中的程序都要采用如上的缩进方式。示例：如下例子不符合规范。for(...){...//programcode}if(...){...//programcode}voidexample_fun(void){...//programcode}应如下书写。for(...){...//programcode}if(...){...//programcode}voidexample_fun(void){...//programcode}1-111-111-111-11：在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如－），后不应第5页加空格。说明：采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加空格，因为在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&&cd)1-11-11-11-12222：一行程序以小于80808080字符为宜，不要写得过长。第6页2222注释注释注释注释2-12-12-12-1：一般情况下，源程序有效注释量必须在20202020％以上。说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。2-22-22-22-2：说明性文件（如头文件.h.h.h.h文件、.inc.inc.inc.inc文件、.def.def.def.def文件、编译说明文件.cfg.cfg.cfg.cfg等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。/*************************************************Copyright(C),1988-1999,HuaweiTech.Co.,Ltd.Filename://文件名Author:Version:Date://作者、版本及完成日期Description://用于详细说明此程序文件完成的主要功能，与其他模块//或函数的接口，输出值、取值范围、含义及参数间的控//制、顺序、独立或依赖等关系Others://其它内容的说明FunctionList://主要函数列表，每条记录应包括函数名及功能简要说明1.....History://修改历史记录列表，每条修改记录应包括修改日期、修改//者及修改内容简述1.Date:Author:Modification:2....*************************************************/2-32-32-32-3：源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的////功能、主要函数及其功能、修改日志等。示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。/************************************************************Copyright(C),1988-1999,HuaweiTech.Co.,Ltd.FileName:test.cppAuthor:Version:Date:Description://模块描述Version://版本信息FunctionList://主要函数及其功能1.-------History://历史修改记录authortimeversiondescDavid96/10/121.0buildthismoudle***********************************************************/第7页说明：Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。History是修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述。2-42-42-42-4：函数头部应进行注释，列出：函数的目的////功能、输入参数、输出参数、返回值、调用关系（函数、表）等。示例：下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。/*************************************************Function://函数名称Description://函数功能、性能等的描述Calls://被本函数调用的函数清单CalledBy://调用本函数的函数清单TableAccessed://被访问的表（此项仅对于牵扯到数据库操作的程序）TableUpdated://被修改的表（此项仅对于牵扯到数据库操作的程序）Input://输入参数说明，包括每个参数的作//用、取值说明及参数间关系。Output://对输出参数的说明。Return://函数返回值的说明Others://其它说明***********************************************