华为软件编程规范和范例
2024版Verilog编程规范(华为)
实现自动化测试流程，提高测试 效率和准确性。
06
代码审查与质量保证
代码审查流程介绍
提交代码
开发人员将代码提交到代码审查 系统中。
分配审查任务
系统或审查组长将审查任务分配 给审查人员。
代码审查
审查人员对代码进行逐行审查， 检查是否符合编程规范和质量要
求。
审查通过
经过多轮反馈和整改后，代码符 合要求，审查通过。
通过定期的培训、分享和宣传活动，提高开 发人员对Verilog编程规范的认识和重视程度。
引入自动化检查工具
建立持续改进机制
研究和引入自动化检查工具，对Verilog代码 进行静态分析和规范检查，进一步提高代码 质量和开发效率。
建立规范的持续改进机制，收集开发人员的 反馈和建议，及时调整和优化规范内容。
可重用性原则
模块应具有高内聚、低耦 合的特点，便于在不同项 目中重用。
可维护性原则
模块应易于理解、测试和 修改，以降低维护成本。
顶层结构设计方法
自顶向下设计
从系统整体需求出发，逐 步细化到各个模块的设计 和实现。
模块化设计
将系统划分为多个独立的 模块，每个模块承担一定 的功能，便于并行开发和 维护。
减少错误和提高代码质量
02
规范的编程习惯有助于减少编码过程中的错误，提高代码的稳
定性和可靠性。
促进知识共享和传承
03
统一的编程规范有利于知识的积累和传承，降低新人学习成本，
提高团队整体技术水平。
适用范围及对象
适用范围
本规范适用于使用Verilog语言进 行硬件描述和设计的所有场景，包 括但不限于数字电路设计、验证、 仿真等。
端口名应避免与模块内部变量名冲突。
华为软件开发规范
华为软件开发规范软件开发规范1 排版¹1-1：程序块要采用缩进风格编写，缩进的空格数为4个。
说明：对于由开发工具自动生成的代码可以有不一致。
¹1-2：相对独立的程序块之间、变量说明之后必须加空行。
示例：如下例子不符合规范。
if (!valid_ni(ni)){... // program code}repssn_ind =仅供内部使用2ssn_data[index].repssn_index;repssn_ni = ssn_data[index].ni;应如下书写if (!valid_ni(ni)){... // program code}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 );仅供内部使用3act_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 < MAX_ACT_TASK_NUMBER)&& (n7stat_stat_item_valid (stat_item))&& (act_task_table[taskno].result_data != 0)); 仅供内部使用4¹1-4：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。
第5章 华为软件编码规范
(4)"->"、"."前后不加空格。 p->id = pid; // "->"指针前后不加空格 (5) if、for、while、switch等与后面的括号间应 加空格，使if等关键字更为突出、明显。
if (a >= b && c > d) 注意：一行程序以小于80字符为宜，不要写得过长。
2014年9月24日星期三 15
2014年9月24日星期三 14
(3)"!"、"~"、"++"、"--"、"&"（地址运算符）等 单目操作符前后不加空格。
*p = 'a'; // 内容操作"*"与内容之间 flag = !isEmpty; // 非操作"!"与内容之间 p = &mem; // 地址操作"&" 与内容之间 i++; // "++","--"与内容之间
〔二〕 ======[ 注释 ]=======
2014年9月24日星期三
16
¹ 2-1：一般情况下，源程序有效注释量 必须在20％以上
说明：注释的原则是有助于对程序的阅读理解， 在该加的地方都加了，注释不宜太多也不能太 少，注释语言必须准确、易懂、简洁。
2014年9月24日星期三
17
¹ 2-2：说明性文件（如头文件.h文件、.inc文件、.def文件、编译说 明文件.cfg等）头部应进行注释，注释必须列出：版权说明、版本 号、生成日期、作者、内容、功能、与其它文件的关系、修改日 志等，头文件的注释中还应有函数功能简要说明
华为软件编程规范
仅供内部使用 6
PDF 文件使用 "pdfFactory Pro" 试用版本创建
软件编程规范总则
1 排版
(2)比较操作符, 赋值操作符"="、 "+="，算术操作符"+"、"%"，逻辑操作符"&&"、 "&"，位域操作符"<<"、"^"等双目操作符的前后加空格。 if (current_time >= MAX_TIME_VALUE) a = b + c; a *= 2; a = b ^ 2;
应如下书写。 for (...) {
... // program code }
if (...) {
... // program code }
void example_fun( void ) {
... // program code }
¹1-11：在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或 者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如－>），后不应加空 格。
软件编程规范总则
2 注释
2 注释
¹2-1：一般情况下，源程序有效注释量必须在20％以上。 说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不 能太少，注释语言必须准确、易懂、简洁。
¹2-2：说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应
应如下书写 if (!valid_ni(ni)) {
华为软件编码规范
华为软件编程规范和范例〔一〕=====[排版] ]=======.〔二〕======[注释]=======.〔三〕=====[标识符命名]=======.〔四〕=====[可读性]======.〔五〕=====[变量、结构]=====.〔六〕=====[函数、过程]=====.〔七〕=====[可测性]=====.〔八〕=====[程序效率]=====.〔九〕=====[质量保证]=====.〔十〕=====[代码编辑、编译、审查]=====.〔十一〕=====[代码测试、维护]=====.〔十二〕=====[宏]=====.〔一〕========[ 排版]========== ¹1-1：程序块要采用缩进风格编写，缩进的空格数为4个说明：对于由开发工具自动生成的代码可以有不一致。
¹1-2：相对独立的程序块之间、变量说明之后必须加空行示例：如下例子不符合规范。
Int ni;if (!valid_ni(ni)){... // program code}repssn_ind = ssn_data[index].repssn_index;repssn_ni = ssn_data[index].ni;应如下书写Int ni;if (!valid_ni(ni)){... // program code}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 < MAX_ACT_TASK_NUMBER)&& (n7stat_stat_item_valid (stat_item))&& (act_task_table[taskno].result_data != 0));¹1-4：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首示例：if ((taskno < max_act_task_number)&& (n7stat_stat_item_valid (stat_item))){... // program code}for (i = 0, j = 0; (i < BufferKeyword[word_index].word_length)&& (j < NewKeyword.word_length); i++, j++){... // program code}for (i = 0, j = 0;(i < first_word_length) && (j < second_word_length);i++, j++){... // program code}¹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：不允许把多个短语句写在一行中，即一行只写一条语句示例：如下例子不符合规范。
华为软件编程规范
精选文档目录1 排版62 注释113 标识符命名184 可读性205 变量、结构226 函数、过程287 可测性368 程序效率409 质量保证4410 代码编辑、编译、审查5011 代码测试、维护5212 宏531 排版¹1-1：程序块要采用缩进风格编写，缩进的空格数为4个。
说明：对于由开发工具自动生成的代码可以有不一致。
¹1-2：相对独立的程序块之间、变量说明之后必须加空行。
示例：如下例子不符合规范。
if (!valid_ni(ni)){... // program code}repssn_ind = ssn_data[index].repssn_index;repssn_ni = ssn_data[index].ni;应如下书写if (!valid_ni(ni)){... // program code}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 < MAX_ACT_TASK_NUMBER)&& (n7stat_stat_item_valid (stat_item))&& (act_task_table[taskno].result_data != 0));¹1-4：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。
华为软件编程规范
总体原则•清晰，易于维护、易于重构•简洁，易于理解，并且易于实现• 风格统一，代码整体风格保持统一• 通用性，遵循业界通用的编程规范目录结构建议将工程按照功能模块划份子目录(可参考头文件和源文件目录。
命名LiteOS 的功能模块划分)，子目录再定义• 使用驼峰风格进行命名，此风格大小写字母混用，不同单词间通过单词首字母大写来分开，具体规则如下：大驼峰，或者带有模块函数，自定义的类型前缀的大驼峰局部变量，函数参数，宏参数，结构体成员，联合体成员全局变量宏，枚举值小驼峰带'g_'前缀的小驼峰全大写并下划线分割带'_LOS'前缀和'H'内核头文件中防止重复包含的宏变量以下划线分割AaaBbb,XXX_AaaBbb aaaBbbg_aaaBbbAAA_BBB_LOS_MODULE_H• 全局函数、全局变量、宏、类型名、枚举名的命名，应当准确描述并全局惟一后缀，中间为大写模块名，• 在能够准确表达含义的前提下，局部变量，或者结构体、联合体的成员变量，其命名应尽可能简短• LiteOS 的对外API 使用LOS_Module_Func 的方式，如果有宾语采用前置的方式，比如：1. LOS_TaskCreate2. LOS_SwtmrStart3. LOS_SemPendkernel 目录下内部模块间接口使用OsModuleFunc 的方式，比如：1. OsTaskScan2. OsSwtmrStartarch 目录需要给上层模块提供LowLevel 接口，这部份接口采用ArchModuleFunc 的方式。
其他情况可采用ModuleFunc 的方式。
排版与格式•程序块采用缩进风格编写，使用空格而不是制表符( '\t' )进行缩进，每级缩进为 4 个空格• 采用K&R 风格作为大括号换行风格，即函数左大括号另起一行放行首，并独占一行，其他左大括号尾随语句放行末，右大括号独占一行，除非后面跟着同一语句的剩余部份，如if 语句的else/elseif 或者分号，比如：1. struct MyType {//左大括号尾随语句放行末，前置 1 个空格2. ...3. };//右大括号后面紧跟分号1. int Foo (int a)2. {//函数左大括号独占一行，放行首3. if(a>0){//左大括号尾随语句放行末，前置 1 个空格4. ...5. }else {//右大括号、 "else" 、以及后续的左大括号均在同一行6. ...7. }//右大括号独占一行8. ...9. }•条件、循环语句使用大括号，比如：1. if(objectIsNotExist){ //单行条件语句也加大括号2. return CreateNewObject ();3. }1. while (condition){} //即使循环体是空，也应使用大括号1. while (condition){2. continue ;//continue 表示空逻辑，使用大括号3. }•case/default 语句相对switch 缩进一层，缩进风格如下：1. switch (var){2. case 0://缩进一层3. DoSomething1 ();//缩进一层4. break ;5. case 1 :6. DoSomething2 ();7. break ;8. default :9. break ;10. }•一行只写一条语句• 一条语句不能过长，建议不超过120 个字符，如不能缩短语句则需要分行写• 换行时将操作符留在行末，新行进行同类对齐或者缩进一层，比如：1. //假设下面第一行不满足行宽要求2. if(currentValue>MIN&& //换行后，布尔操作符放在行末3. currentValue<MAX){ //与 (&&)操作符的两个操作数同类对齐4. DoSomething ();5. ...6. }1. //假设下面的函数调用不满足行宽要求，需要换行2. ReturnType result= FunctionName (paramName1,3. paramName2,4. paramName3); //保持与上方参数对齐1. ReturnType result= VeryVeryVeryLongFunctionName (// 写入第 1 个参数后导致过长，直接换行2. paramName1,paramName2,paramName3); //换行后， 4 空格缩进一层1. //每行的参数代表一组相关性较强的数据结构，放在一行便于理解，此时可理解性优先于格式排版要求2. int result= DealWithStructLikeParams (left.x,left.y, //表示一组相关参数3. right.x,right.y); //表示此外一组相关参数• 声明定义函数时，函数的返回类型以及其他修饰符，与函数名同行• 指针类型"*" 应该靠右尾随变量或者函数名，比如：1. int*p1;//Good ：右尾随变量，和左边的类型隔了 1 个空格2. int*p2;//Bad ：左尾随类型3. int*p3;//Bad ：两边都没空格4. int*p4;//Bad ：两边都有空格当"*"与变量或者函数名之间有其他修饰符，无法尾随时，此时也不要尾随修饰符，比如：1. char *const VERSION= "V100" ;//Good ：当有 const 修饰符时， "*"两边都有空格2. int Foo (constchar *restrictp); //Good ：当有 restrict 修饰符时， "*"两边都有空格•根据上下内容的相关程度，合理安排空行，但不要使用连续 3 个或者更多空行• 编译预处理的"#"统一放在行首，无需缩进。
华为软件编程规范
目录1排版6 2注释11 3标识符命名18 4可读性20 5变量、结构22 6函数、过程28 7可测性36 8程序效率40 9质量保证44 10代码编辑、编译、审查50 11代码测试、维护52 12宏531排版¹1-1：程序块要采用缩进风格编写，缩进的空格数为4个。
说明：对于由开发工具自动生成的代码可以有不一致。
¹1-2：相对独立的程序块之间、变量说明之后必须加空行。
示例：如下例子不符合规范。
if(!valid_ni(ni)){...//program code}repssn_ind=ssn_data[index].repssn_index;repssn_ni=ssn_data[index].ni;应如下书写if(!valid_ni(ni)){...//program code}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<MAX_ACT_TASK_NUMBER)&&(n7stat_stat_item_valid(stat_item))&&(act_task_table[taskno].result_data!=0));¹1-4：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。
华为编程规范全PDF
// 修改历史记录列表，每条修改记录应包括修改日期、修改
// 者及修改内容简述
1. Date:
Author:
Modification:
2. ... *************************************************/
¹2-3：源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、 主要函数及其功能、修改日志等。 示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包 含在内。
由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格， 如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不 必加空格，因为在 C/C++语言中括号已经是最清晰的标志了。 在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操 作符留空格时不要连续留两个以上空格。 示例： (1) 逗号、分号只在后面加空格。 int a, b, c;
Version:
// 版本信息
Function List: // 主要函数及其功能
1. -------
History:
// 历史修改记录
<author> <time> <version > <desc>
David 96/10/12 1.0 build this moudle
***********************************************************/
for (i = 0, j = 0; (i < BufferKeyword[word_index].word_length) && (j < NewKeyword.word_length); i++, j++)
华为软件编程规范
华为软件编程规范目录1 排版 62 注释113 标识符命名184 可读性205 变量、结构226 函数、过程287 可测性368 程序效率409 质量保证4410 代码编辑、编译、审查5011 代码测试、维护5212 宏53软件编程规范总则1 排版仅供内部使用71 排版¹1-1：程序块要采用缩进风格编写，缩进的空格数为4个。
说明：对于由开发工具自动生成的代码可以有不一致。
¹1-2：相对独立的程序块之间、变量说明之后必须加空行。
示例：如下例子不符合规范。
if (!valid_ni(ni)) {... // program code }repssn_ind =ssn_data[index].repssn_index; repssn_ni = ssn_data[index].ni;应如下书写软件编程规范总则1 排版仅供内部使用7if (!valid_ni(ni)){... // program code }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 < MAX_ACT_TASK_NUMBER)软件编程规范总则 1 排版仅供内部使用7&& (n7stat_stat_item_valid (stat_item))&& (act_task_table[taskno].result_data != 0));¹1-4：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。
华为软件开发规范标准
软件开发规1 排版¹1-1：程序块要采用缩进风格编写，缩进的空格数为4个。
说明：对于由开发工具自动生成的代码可以有不一致。
¹1-2：相对独立的程序块之间、变量说明之后必须加空行。
示例：如下例子不符合规。
if (!valid_ni(ni)){... // program code}repssn_ind = ssn_data[index].repssn_index;repssn_ni = ssn_data[index].ni;应如下书写if (!valid_ni(ni)){... // program code}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 < MAX_ACT_TASK_NUMBER)&& (n7stat_stat_item_valid (stat_item))&& (act_task_table[taskno].result_data != 0));¹1-4：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。
华为软件编程规范和范例
华为软件编程规范和范例NetReptile推荐 [2006-5-23]出处：/oosky/作者：任我行〔一〕=====[排版] ]=======.〔二〕======[注释]=======.〔三〕=====[标识符命名]=======.〔四〕=====[可读性]======.〔五〕=====[变量、结构]=====.〔六〕=====[函数、过程]=====.〔七〕=====[可测性]=====.〔八〕=====[程序效率]=====.〔九〕=====[质量保证]=====.〔十〕=====[代码编辑、编译、审查]=====.〔十一〕=====[代码测试、维护]=====.〔十二〕=====[宏]=====.〔一〕=====[ 排版]¹1-1：程序块要采用缩进风格编写，缩进的空格数为4个说明：对于由开发工具自动生成的代码可以有不一致。
¹1-2：相对独立的程序块之间、变量说明之后必须加空行示例：如下例子不符合规范。
if (!valid_ni(ni)){... // program code}repssn_ind = ssn_data[index].repssn_index;repssn_ni = ssn_data[index].ni;应如下书写if (!valid_ni(ni)){... // program code}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 < MAX_ACT_TASK_NUMBER)&& (n7stat_stat_item_valid (stat_item))&& (act_task_table[taskno].result_data != 0));¹1-4：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首示例：if ((taskno < max_act_task_number)&& (n7stat_stat_item_valid (stat_item))){... // program code}for (i = 0, j = 0; (i < BufferKeyword[word_index].word_length)&& (j < NewKeyword.word_length); i++, j++){... // program code}for (i = 0, j = 0;(i < first_word_length) && (j < second_word_length);i++, j++){... // program code}¹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：不允许把多个短语句写在一行中，即一行只写一条语句示例：如下例子不符合规范。
tvt完全免费下载华为编程规范与范例
sizeof (_STAT_OBJECT));
n7stat_flash_act_duration( stat_item, frame_id *STAT_TASK_CHECK_NUMBER
+ index, stat_object );
11-6：不允许把多个短语句写在一行中，即一行只写一条语句。
示例：如下例子不符合规范。
for (...) {
... // program code
}
if (...)
{
... // program code
}
void example_fun( void )
{
... // program code
1 排版
6
2 注释
11
3 标识符命名
18
4 可读性
20
5 变量、结构
22
6 函数、过程
28
7 可测性
36
8 程序效率
40
9 质量保证
44
10 代码编辑、编译、审查
50
11 代码测试、维护
52
示例：
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
进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的
关系、修改日志等，头文件的注释中还应有函数功能简要说明。
华为软件编程规范总则
目录1 排版 (2)2 注释 (8)规则2-7：避免在注释中使用缩写，特别是非常用缩写。
(10)3 标识符命名 (16)4 可读性 (19)5 变量、结构 (21)6 函数、过程 (28)建议6-14：避免使用无意义或含义不清的动词为函数命名。
(33)建议6-15：函数的返回值要清楚、明了，让使用者不容易忽视错误情况。
(33)7 可测性 (37)8 程序效率 (42)9 质量保证 (47)10 代码编辑、编译、审查 (54)11 代码测试、维护 (56)12 宏 (58)1 排版¹1-1：程序块要采用缩进风格编写，缩进的空格数为4个。
说明：对于由开发工具自动生成的代码可以有不一致。
¹1-2：相对独立的程序块之间、变量说明之后必须加空行。
示例：如下例子不符合规范。
if (!valid_ni(ni)){... // program code}repssn_ind = ssn_data[index].repssn_index;repssn_ni = ssn_data[index].ni;应如下书写if (!valid_ni(ni)){... // program code}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 < MAX_ACT_TASK_NUMBER)&& (n7stat_stat_item_valid (stat_item))&& (act_task_table[taskno].result_data != 0));¹1-4：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。
华为软件开发规范
软件开发规范1 排版¹1-1：程序块要采用缩进风格编写，缩进的空格数为4个。
说明：对于由开发工具自动生成的代码可以有不一致。
¹1-2：相对独立的程序块之间、变量说明之后必须加空行。
示例：如下例子不符合规范。
if (!valid_ni(ni)){... // program code}repssn_ind = ssn_data[index].repssn_index;repssn_ni = ssn_data[index].ni;应如下书写if (!valid_ni(ni)){... // program code}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 < MAX_ACT_TASK_NUMBER)&& (n7stat_stat_item_valid (stat_item))&& (act_task_table[taskno].result_data != 0));¹1-4：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
华为软件编程规范和范例1. 排版11.1程序块要采用缩进风格编写, 缩进的空格数为4个。
说明: 对于由开发工具自动生成的代码可以有不一致。
1.2相对独立的程序块之间、变量说明之后必须加空行。
示例: 如下例子不符合规范。
if (!valid_ni(ni)){... // program code}repssn_ind = ssn_data[index].repssn_index;repssn_ni = ssn_data[index].ni;应如下书写:if (!valid_ni(ni)){... // program code}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 < MAX_ACT_TASK_NUMBER)&& (n7stat_stat_item_valid (stat_item))&& (act_task_table[taskno].result_data != 0));1.4循环、判断等语句中若有较长的表达式或语句, 则要进行适应的划分, 长表达式要在低优先级操作符处划分新行, 操作符放在新行之首。
示例:if ((taskno < max_act_task_number)&& (n7stat_stat_item_valid (stat_item))){... // program code}for (i = 0, j = 0; (i < BufferKeyword[word_index].word_length)&& (j < NewKeyword.word_length); i++, j++){... // program code}for (i = 0, j = 0;(i < first_word_length) && (j < second_word_length);i++, j++){... // program code}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.7if、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 (...) {... // program code}if (...){... // program code}void example_fun( void ){... // program code}应如下书写。
for (...){... // program code}if (...){... // program code}void example_fun( void ){... // program code}1.11在两个以上的关键字、变量、常量进行对等操作时, 它们之间的操作符之前、之后或者前后要加空格; 进行非对等操作时, 如果是关系密切的立即操作符(如->), 后不应加空格。
说明: 采用这种松散方式编写代码的目的是使代码更加清晰。
由于留空格所产生的清晰性是相对的, 所以, 在已经非常清晰的语句中没有必要再留空格, 如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格, 多重括号间不必加空格, 因为在C/C++语言中括号已经是最清晰的标志了。
在长语句中, 如果需要加的空格非常多, 那么应该保持整体清晰, 而在局部不加空格。
给操作符留空格时不要连续留两个以上空格。
示例:(1) 逗号、分号只在后面加空格。
int a, 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一行程序以小于80字符为宜, 不要写得过长。
2. 注释1234562.1一般情况下, 源程序有效注释量必须在20％以上。
说明: 注释的原则是有助于对程序的阅读理解, 在该加的地方都加了, 注释不宜太多也不能太少, 注释语言必须准确、易懂、简洁。
2.2说明性文件(如头文件.h 文件、.inc 文件、.def 文件、编译说明文件.cfg 等)头部应进行注释, 注释必须列出: 版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等, 头文件的注释中还应有函数功能简要说明。
示例: 下面这段头文件的头注释比较标准, 当然, 并不局限于此格式, 但上述信息建议要包含在内。
/*************************************************Copyright (C), 1988-1999, Huawei Tech. Co., Ltd.File name: // 文件名Author: Version: Date: // 作者、版本及完成日期Description: // 用于详细说明此程序文件完成的主要功能, 与其他模块// 或函数的接口, 输出值、取值范围、含义及参数间的控// 制、顺序、独立或依赖等关系Others: // 其它内容的说明Function List: // 主要函数列表, 每条记录应包括函数名及功能简要说明1. ...History: // 修改历史记录列表, 每条修改记录应包括修改日期、修改// 者及修改内容简述1. Date:Author:Modification:2. ...*************************************************/2.3源文件头部应进行注释, 列出: 版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。
示例: 下面这段源文件的头注释比较标准, 当然, 并不局限于此格式, 但上述信息建议要包含在内。
/************************************************************Copyright (C), 1988-1999, Huawei Tech. Co., Ltd.FileName: test.cppAuthor: Version : Date:Description: // 模块描述Version: // 版本信息Function List: // 主要函数及其功能1. ...History: // 历史修改记录<author> <time> <version > <desc>David 96/10/12 1.0 build this moudle***********************************************************/说明: Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。