华为公司编程规范和范例C.doc
- 文档编号:90442
- 上传时间:2022-10-02
- 格式:DOC
- 页数:59
- 大小:162.50KB
华为公司编程规范和范例C.doc
《华为公司编程规范和范例C.doc》由会员分享,可在线阅读,更多相关《华为公司编程规范和范例C.doc(59页珍藏版)》请在冰豆网上搜索。
目录
1排版
6
2注释
11
3标识符命名
18
4可读性
20
5变量、结构
22
6函数、过程
28
7可测性
36
8程序效率
40
9质量保证
44
10代码编辑、编译、审查
50
11代码测试、维护
52
12宏
53
1排版
¹1-1:
程序块要采用缩进风格编写,缩进的空格数为4个。
说明:
对于由开发工具自动生成的代码可以有不一致。
¹1-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-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)); ¹1-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 } ¹1-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); ¹1-6: 不允许把多个短语句写在一行中,即一行只写一条语句。 示例: 如下例子不符合规范。 rect.length=0;rect.width=0; 应如下书写 rect.length=0; rect.width=0; ¹1-7: if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。 示例: 如下例子不符合规范。 if(pUserCR==NULL)return; 应如下书写: if(pUserCR==NULL) { return; } ¹1-8: 对齐只使用空格键,不使用TAB键。 说明: 以免用不同的编辑器阅读程序时,因TAB键所设置的空格数目不同而造成程序布局不整齐,不要使用BC作为编辑器合版本,因为BC会自动将8个空格变为一个TAB键,因此使用BC合入的版本大多会将缩进变乱。 ¹1-9: 函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case语句下的情况处理语句也要遵从语句缩进要求。 ¹1-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 } ¹1-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-1: 一行程序以小于80字符为宜,不要写得过长。 2注释 ¹2-1: 一般情况下,源程序有效注释量必须在20%以上。 说明: 注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。 ¹2-2: 说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出: 版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。 示例: 下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。 /************************************************* Copyright(C),1988-1999,HuaweiTech.Co.,Ltd. Filename: //文件名 Author: Version: Date: //作者、版本及完成日期 Description: //用于详细说明此程序文件完成的主要功能,与其他模块 //或函数的接口,输出值、取值范围、含义及参数间的控 //制、顺序、独立或依赖等关系 Others: //其它内容的说明 FunctionList: //主要函数列表,每条记录应包括函数名及功能简要说明 1..... History: //修改历史记录列表,每条修改记录应包括修改日期、修改 //者及修改内容简述 1.Date: Author: Modification: 2.... *************************************************/ ¹2-3: 源文件头部应进行注释,列出: 版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。 示例: 下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。 /************************************************************ Copyright(C),1988-1999,HuaweiTech.Co.,Ltd. FileName: test.cpp Author: Version: Date: Description: //模块描述 Version: //版本信息 Functio
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 华为 公司 编程 规范 范例