华为代码规范文档
华为编程规范
示例： (1) 逗号、分号只在后面加空格。 int a, b, c;
仅供内部使用
6
软件编程规范总则
1 排版
(2)比较操作符, 赋值操作符"="、 "+="，算术操作符"+"、"%"，逻辑操作符"&&"、 "&"，位域操作符"<<"、"^"等双目操作符的前后加空格。 if (current_time >= MAX_TIME_VALUE) a = b + c; a *= 2; a = b ^ 2; (3)"!"、"~"、"++"、"--"、"&"（地址运算符）等单目操作符前后不加空格。 *p = 'a'; p = &mem; i++; // 内容操作"*"与内容之间 // 地址操作"&" 与内容之间 // "++","--"与内容之间 flag = !isEmpty; // 非操作"!"与内容之间
华为的编程规范和范例
目录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：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。
华为代码规范文档
代码规范文档目录1 概述 (5)1.1 编写目的 (5)1.2 文档约定 (5)1.3 预期的读者和阅读建议 (5)1.4 参考文献 (5)2 排版要求 (5)2.1 程序块缩进 (5)2.2 程序块之间空行 (5)2.3 长语句和长表达式 (6)2.4 循环、判断等长表达式或语句 (7)2.5 长参数 (7)2.6 短语句 (8)2.7 条件、循环语句 (8)2.8 语句对齐 (8)2.9 函数、过程和结构等语句块 (9)2.10 程序块分界符 (9)2.11 操作符前后空格 (10)2.12 其他 (11)3 注释 (11)3.1 有效注释量 (11)3.2 公司标识 (11)3.3 说明性文件 (12)3.4 源文件头 (13)3.5 函数头部说明 (13)3.6 注释与代码一致 (14)3.7 注释内容 (14)3.8 注释缩写 (14)3.9 注释位置 (14)3.10 变量、常量注释 (15)3.11 数据结构的注释 (15)3.12 全局变量 (16)3.13 注释缩排 (16)3.14 注释与代码之间空行 (17)3.15 变量定义、分支语句 (17)3.16 其他 (19)4 标识符命名 (20)4.1 命名清晰 (20)4.2 特殊命名需注释 (21)4.3 命名风格保持一致 (21)4.4 变量命名 (21)4.5 命名规范与系统风格一致 (21)4.6 其他 (22)5 可读性 (23)5.1 运算符优先级 (23)5.2 避免直接使用数字作为标识符 (23)5.3 其他 (24)6 变量、结构 (25)6.1 公共变量 (25)6.2 公共变量说明 (25)6.3 公共变量访问说明 (25)6.4 公共变量赋值 (26)6.5 防止局部变量与公共变量同名。
(26)6.6 严禁使用未经初始化的变量作为右值。
(26)6.7 其他 (26)7 函数、过程 (34)7.1 对所调用函数的错误返回码要仔细、全面地处理。
华为的编程规范和范例
{ ... // program code
}
for (i = 0, j = 0; (i < first_word_length) && (j < second_word_length); i++, j++)
Function:
// 函数名称
Description: // 函数功能、性能等的描述
Calls:
// 被本函数调用的函数清单
Called By:
// 调用本函数的函数清单
Table Accessed: // 被访问的表（此项仅对于牵扯到数据库操作的程序）
Table Updated: // 被修改的表（此项仅对于牵扯到数据库操作的程序）
n7stat_flash_act_duration( stat_item, frame_id *STAT_TASK_CHECK_NUMBER + index, stat_object );
¹1-6：不允许把多个短语句写在一行中，即一行只写一条语句。 示例：如下例子不符合规范。 rect.length = 0; rect.width = 0;
应如下书写： if (pUserCR == NULL) {
return; }
¹1-8：对齐只使用空格键，不使用TAB键。 说明：以免用不同的编辑器阅读程序时，因 TAB 键所设置的空格数目不同而造成程序布 局不整齐，不要使用 BC 作为编辑器合版本，因为 BC 会自动将 8 个空格变为一个 TAB 键， 因此使用 BC 合入的版本大多会将缩进变乱。
华为软件编程规范和范例
目录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 * STA T_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：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。
华为内部代码规范
FileName: test.cpp
Author:
Version :
Description: // 模块描述
Date:
Version:
// 版本信息
Function List: // 主要函数及其功能
1. -------
History:
// 历史修改记录
<author> <time> <version > <desc>
包含在内。
/*************************************************
Copyright (C), 1988-1999, Huawei Tech. Co., Ltd.
File name:
// 文件名
Author:
Version:
Date: // 作者、版本及完成日期
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 );
软件编程规范总则
&& (n7stat_stat_item_valid (stat_item)) && (act_task_table[taskno].result_data != 0));
1 排版
仅供内部使用 3
华为公司编程规范和范例(C++)
目录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))免费毕业设计辅导咨询9361235@&& (act_task_table[taskno].result_data != 0));¹1-4：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。
华为-编程规范和范例
目录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-11-1：程序块要采用缩进风格编写，缩进的空格数为：程序块要采用缩进风格编写，缩进的空格数为：程序块要采用缩进风格编写，缩进的空格数为44个。
说明：对于由开发工具自动生成的代码可以有不一致。
¹1-21-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-31-3：较长的语句（：较长的语句（：较长的语句（>80>80>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-41-4：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。
华为内部代码规范
应如下书写
仅供内部使用 4
软件编程规范总则
1 排版
rect.length = 0; rect.width = 0;
¹1-7：if、for、do、while、case、switch、default等语句自占一行，且if、for、
(5) if、for、while、switch 等与后面的括号间应加空格，使 if 等关键字更为突出、 明显。 if (a >= b && c > d)
½1-1：一行程序以小于80字符为宜，不要写得过长。
仅供内部使用 7
软件编程规范总则
2 注释
2 注释
¹2-1：一般情况下，源程序有效注释量必须在20％以上。 说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不 能太少，注释语言必须准确、易懂、简洁。
包含在内。
/*************************************************
Copyright (C), 1988-1999, Huawei Tech. Co., Ltd.
File name:
// 文件名
Author:
Version:
Date: // 作者、版本及完成日期
示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要 包含在内。
仅供内部使用 8
软件编程规范总则
2 注释
/************************************************************
华为软件编码规范
华为软件编程规范和范例〔一〕=====[排版] ]=======.〔二〕======[注释]=======.〔三〕=====[标识符命名]=======.〔四〕=====[可读性]======.〔五〕=====[变量、结构]=====.〔六〕=====[函数、过程]=====.〔七〕=====[可测性]=====.〔八〕=====[程序效率]=====.〔九〕=====[质量保证]=====.〔十〕=====[代码编辑、编译、审查]=====.〔十一〕=====[代码测试、维护]=====.〔十二〕=====[宏]=====.〔一〕========[ 排版]========== ¹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：不允许把多个短语句写在一行中，即一行只写一条语句示例：如下例子不符合规范。
2024版年度Verilog编程规范(华为)
通过定期的培训、分享和宣传活动，提高开 发人员对Verilog编程规范的认识和重视程度。
引入自动化检查工具
建立持续改进机制
研究和引入自动化检查工具，对Verilog代码 进行静态分析和规范检查，进一步提高代码 质量和开发效率。
建立规范的持续改进机制，收集开发人员的 反馈和建议，及时调整和优化规范内容。
同步/异步通信
根据实际需求选择同步或异步通信方式，确保子模块间的协同工 作。
20
时钟域划分及时序收敛策略
时钟域划分
根据系统时钟需求，将设计划分为不同的时钟域， 避免跨时钟域操作带来的问题。
时序收敛策略
采用合适的时序收敛方法，如时钟同步、异步 FIFO等，确保数据在不同时钟域间正确传输。
时序约束与验证
2024/2/2
01 注释应清晰明了，准确描述代码的功能和 实现方法。
02 注释应与代码同步更新，避免注释与代码 不一致。
03
注释应使用中文或英文，避免使用其他语 言。
04
对于重要的函数、模块和算法，应在文件 开头添加注释说明。
14
空格和换行使用原则
关键字与括号之间应加空 格，如`if (`、`for (`等。
开发效率提高
规范的编码风格使得开发人员能够更快速地理解和修改代码，提高 了开发效率。
团队协作更加顺畅
统一的编程规范促进了团队成员之间的协作，减少了因代码风格不同 而产生的沟通成本。
2024/2/2
31
未来改进方向
持续优化规范内容
加强规范培训和宣传
根据业界最佳实践和团队实际经验，持续优 化Verilog编程规范的内容，以适应新的技术 和应用场景。
一种硬件描述语言 （Hardware Description Language，HDL），用于 描述数字电路和系统。
华为编程规范
目录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：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。
华为代码规范文档
代码规范文档目录1 概述 (5)1.1 编写目的 (5)1.2 文档约定 (5)1.3 预期的读者和阅读建议 (5)1.4 参考文献 (5)2 排版要求 (5)2.1 程序块缩进 (5)2.2 程序块之间空行 (5)2.3 长语句和长表达式 (6)2.4 循环、判断等长表达式或语句 (7)2.5 长参数 (7)2.6 短语句 (8)2.7 条件、循环语句 (8)2.8 语句对齐 (8)2.9 函数、过程和结构等语句块 (9)2.10 程序块分界符 (9)2.11 操作符前后空格 (10)2.12 其他 (11)3 注释 (11)3.1 有效注释量 (11)3.2 公司标识 (11)3.3 说明性文件 (12)3.4 源文件头 (13)3.5 函数头部说明 (13)3.6 注释与代码一致 (14)3.7 注释内容 (14)3.8 注释缩写 (14)3.9 注释位置 (14)3.10 变量、常量注释 (15)3.11 数据结构的注释 (15)3.12 全局变量 (16)3.13 注释缩排 (16)3.14 注释与代码之间空行 (17)3.15 变量定义、分支语句 (17)3.16 其他 (19)4 标识符命名 (20)4.1 命名清晰 (20)4.2 特殊命名需注释 (21)4.3 命名风格保持一致 (21)4.4 变量命名 (21)4.5 命名规范与系统风格一致 (21)4.6 其他 (22)5 可读性 (23)5.1 运算符优先级 (23)5.2 避免直接使用数字作为标识符 (23)5.3 其他 (24)6 变量、结构 (25)6.1 公共变量 (25)6.2 公共变量说明 (25)6.3 公共变量访问说明 (25)6.4 公共变量赋值 (26)6.5 防止局部变量与公共变量同名。
(26)6.6 严禁使用未经初始化的变量作为右值。
(26)6.7 其他 (26)7 函数、过程 (34)7.1 对所调用函数的错误返回码要仔细、全面地处理。
华为编程规范全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++)
华为编程规范精选
本文由ｆａｎｇｌｉａｎｇ４２５贡献 ｐｐｔ１。
１－１：程序块要采用缩进风格编写，缩进的空格数为４个。
：程序块要采用缩进风格编写，缩进的空格数为 个 说明：对于由开发工具自动生成的代码可以有不一致。
说明：对于由开发工具自动生成的代码可以有不一致。
１－２：相对独立的程序块之间、变量说明之后必须加空行。
：相对独立的程序块之间、变量说明之后必须加空行。
示例：如下例子不符合规范。
示例：如下例子不符合规范。
ｉｆ （！ｖａｌｉｄ＿ｎｉ（ｎｉ）） ｛ …… ／／ ｐｒｏｇｒａｍ ｃｏｄｅ ｝ ｒｅｐｓｓｎ＿ｉｎｄ ＝ ｓｓｎ＿ｄａｔａ［ｉｎｄｅｘ］．ｒｅｐｓｓｎ＿ｉｎｄｅｘ； ｒｅｐｓｓｎ＿ｎｉ ＝ ｓｓｎ＿ｄａｔａ［ｉｎｄｅｘ］．ｎｉ； 应如下书写 ｉｆ （！ｖａｌｉｄ＿ｎｉ（ｎｉ）） ｛ …… ／／ ｐｒｏｇｒａｍ ｃｏｄｅ ｝ ｒｅｐｓｓｎ＿ｉｎｄ ＝ ｓｓｎ＿ｄａｔａ［ｉｎｄｅｘ］．ｒｅｐｓｓｎ＿ｉｎｄｅｘ； ｒｅｐｓｓｎ＿ｎｉ ＝ ｓｓｎ＿ｄａｔａ［ｉｎｄｅｘ］．ｎｉ； １－３：较长的语句（＞８０字符）要分成多行书写，长表达式要在低优先级操作符处划分新 ：较长的语句（ 字符） 字符 要分成多行书写， 操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。
行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。
示例： 示例： ｐｅｒｍ＿ｃｏｕｎｔ＿ｍｓｇ．ｈｅａｄ．ｌｅｎ ＝ ＮＯ７＿ＴＯ＿ＳＴＡＴ＿ＰＥＲＭ＿ＣＯＵＮＴ＿ＬＥＮ ＋ ＳＴＡＴ＿ＳＩＺＥ＿ＰＥＲ＿ＦＲＡＭ ＊ ｓｉｚｅｏｆ（ ＿ＵＬ ）； ａｃｔ＿ｔａｓｋ＿ｔａｂｌｅ［ｆｒａｍｅ＿ｉｄ ＊ ＳＴＡＴ＿ＴＡＳＫ＿ＣＨＥＣＫ＿ＮＵＭＢＥＲ ＋ ｉｎｄｅｘ］．ｏｃｃｕｐｉｅｄ ＝ ｓｔａｔ＿ｐｏｉ［ｉｎｄｅｘ］．ｏｃｃｕｐｉｅｄ； ａｃｔ＿ｔａｓｋ＿ｔａｂｌｅ［ｔａｓｋｎｏ］．ｄｕｒａｔｉｏｎ＿ｔｒｕｅ＿ｏｒ＿ｆａｌｓｅ ＝ ＳＹＳ＿ｇｅｔ＿ｓｃｃｐ＿ｓｔａｔｉｓｔｉｃ＿ｓｔａｔｅ（ ｓｔａｔ＿ｉｔｅｍ ）； ｒｅｐｏｒｔ＿ｏｒ＿ｎｏｔ＿ｆｌａｇ ＝ （（ｔａｓｋｎｏ ＜ ＭＡＸ＿ＡＣＴ＿ＴＡＳＫ＿ＮＵＭＢＥＲ） ＆＆ （ｎ７ｓｔａｔ＿ｓｔａｔ＿ｉｔｅｍ＿ｖａｌｉｄ （ｓｔａｔ＿ｉｔｅｍ）） ＆＆ （ａｃｔ＿ｔａｓｋ＿ｔａｂｌｅ［ｔａｓｋｎｏ］．ｒｅｓｕｌｔ＿ｄａｔａ ！＝ ０））； １－４：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要 ：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分， 在低优先级操作符处划分新行，操作符放在新行之首。
华为软件编程规范和范例
[ 华为软件编程规范和范例]一、排版二、注释三、标识符命名四、可读性五、变量、结构六、函数、过程七、可测性八、程序效率九、质量保证十、代码编辑、编译、审查十一、代码测试、维护十二、宏〔一〕=====[排版]11-1：程序块要采用缩进风格编写，缩进的空格数为4个说明：对于由开发工具自动生成的代码可以有不一致。
11-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;11-3：较长的语句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读示例：+ 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));11-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}11-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 );11-6：不允许把多个短语句写在一行中，即一行只写一条语句示例：如下例子不符合规范。
华为软件编码规范
华为软件编码规范华为软件编程规范和范例〔一〕=====[排版] ]=======. 〔二〕======[注释]=======. 〔三〕=====[标识符命名]=======. 〔四〕=====[可读性]======. 〔五〕=====[变量、结构]=====.〔六〕=====[函数、过程]=====. 〔七〕=====[可测性]=====. 〔八〕=====[程序效率]=====. 〔九〕=====[质量保证]=====.〔十〕=====[代码编辑、编译、审查]=====. 〔十一〕=====[代码测试、维护]=====. 〔十二〕=====[宏]=====.〔一〕 ========[ 排版 ]==========11-1：程序块要采用缩进风格编写，缩进的空格数为4个说明：对于由开发工具自动生成的代码可以有不一致。
11-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;11-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));11-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 }11-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 ); 11-6：不允许把多个短语句写在一行中，即一行只写一条语句示例：如下例子不符合规范。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
代码规范文档目录1 概述错误!未定义书签。
编写目的错误!未定义书签。
文档约定错误!未定义书签。
预期的读者和阅读建议错误!未定义书签。
参考文献错误!未定义书签。
2 排版要求错误!未定义书签。
程序块缩进错误!未定义书签。
程序块之间空行错误!未定义书签。
长语句和长表达式错误!未定义书签。
循环、判断等长表达式或语句错误!未定义书签。
长参数错误!未定义书签。
短语句错误!未定义书签。
条件、循环语句错误!未定义书签。
语句对齐错误!未定义书签。
函数、过程和结构等语句块错误!未定义书签。
程序块分界符错误!未定义书签。
操作符前后空格错误!未定义书签。
其他错误!未定义书签。
3 注释错误!未定义书签。
有效注释量错误!未定义书签。
公司标识错误!未定义书签。
说明性文件错误!未定义书签。
源文件头错误!未定义书签。
函数头部说明错误!未定义书签。
注释与代码一致错误!未定义书签。
注释内容错误!未定义书签。
注释缩写错误!未定义书签。
注释位置错误!未定义书签。
变量、常量注释错误!未定义书签。
数据结构的注释错误!未定义书签。
全局变量错误!未定义书签。
注释缩排错误!未定义书签。
注释与代码之间空行错误!未定义书签。
变量定义、分支语句错误!未定义书签。
其他错误!未定义书签。
4 标识符命名错误!未定义书签。
命名清晰错误!未定义书签。
特殊命名需注释错误!未定义书签。
命名风格保持一致错误!未定义书签。
变量命名错误!未定义书签。
命名规范与系统风格一致错误!未定义书签。
其他错误!未定义书签。
5 可读性错误!未定义书签。
运算符优先级错误!未定义书签。
避免直接使用数字作为标识符错误!未定义书签。
其他错误!未定义书签。
6 变量、结构错误!未定义书签。
公共变量错误!未定义书签。
公共变量说明错误!未定义书签。
公共变量访问说明错误!未定义书签。
公共变量赋值错误!未定义书签。
防止局部变量与公共变量同名。
错误!未定义书签。
严禁使用未经初始化的变量作为右值。
错误!未定义书签。
其他错误!未定义书签。
7 函数、过程错误!未定义书签。
对所调用函数的错误返回码要仔细、全面地处理。
错误!未定义书签。
明确函数功能，精确（而不是近似）地实现函数设计。
错误!未定义书签。
局部变量错误!未定义书签。
全局变量错误!未定义书签。
接口函数参数错误!未定义书签。
其他错误!未定义书签。
8 可测性错误!未定义书签。
调测开关错误!未定义书签。
打印信息错误!未定义书签。
单元测试错误!未定义书签。
集成测试错误!未定义书签。
断言使用错误!未定义书签。
设置与取消有关测试手段时，不能影响软件功能功能错误!未定义书签。
版本维护错误!未定义书签。
其他错误!未定义书签。
9 程序效率错误!未定义书签。
编程时要经常注意代码的效率。
错误!未定义书签。
提高代码效率错误!未定义书签。
全局效率高于局部效率错误!未定义书签。
提高代码空间效率错误!未定义书签。
循环体内工作量最小化错误!未定义书签。
其他错误!未定义书签。
10 质量保证错误!未定义书签。
在软件设计过程中构筑软件质量。
错误!未定义书签。
代码质量保证优先原则错误!未定义书签。
只引用属于自己的存贮空间。
错误!未定义书签。
防止引用已经释放的内存空间。
错误!未定义书签。
内存及时释放错误!未定义书签。
文件句柄及时关闭错误!未定义书签。
防止内存操作越界错误!未定义书签。
认真处理程序所能遇到的各种出错情况错误!未定义书签。
初始化变量错误!未定义书签。
数据一致性检查错误!未定义书签。
严禁随意更改其它模块或系统的有关设置和配置错误!未定义书签。
不能随意改变与其它模块的接口错误!未定义书签。
系统接口错误!未定义书签。
编程时，要防止差1错误错误!未定义书签。
操作符检查错误!未定义书签。
分支语句写完整错误!未定义书签。
使用return语句错误!未定义书签。
不要滥用goto语句错误!未定义书签。
其他错误!未定义书签。
11 代码编辑、编译、审查错误!未定义书签。
打开编译器的所有告警开关对程序进行编译错误!未定义书签。
在产品软件（项目组）中，要统一编译开关选项错误!未定义书签。
通过代码走读及审查方式对代码进行检查。
错误!未定义书签。
测试部测试产品之前，应对代码进行抽查及评审错误!未定义书签。
其他错误!未定义书签。
12 代码测试、维护错误!未定义书签。
单元测试要求至少达到语句覆盖错误!未定义书签。
单元测试开始要跟踪每一条语句，并观察数据流及变量的变化错误!未定义书签。
清理、整理或优化后的代码要经过审查及测试。
错误!未定义书签。
代码版本升级要经过严格测试错误!未定义书签。
使用工具软件对代码版本进行维护错误!未定义书签。
正式版本上软件的任何修改都应有详细的文档记录错误!未定义书签。
其他错误!未定义书签。
13 宏错误!未定义书签。
用宏定义表达式时，要使用完备的括号错误!未定义书签。
将宏所定义的多条表达式放在大括号中错误!未定义书签。
使用宏时，不允许参数发生变化错误!未定义书签。
概述编写目的为规范软件开发人员的代码编写提供参考依据和统一标准。
文档约定说明本文档中所用到的专用术语定义或解释，缩略词定义。
预期的读者和阅读建议本文档适用于所有软件开发人员。
参考文献列出有关的参考文件，如：a．属于本项目的其他已发表文件；b．本文件中各处引用的文档资料。
列出这些文件的标题、作者，说明能够得到这些文件资料的来源。
排版要求程序块缩进程序块要采用缩进风格编写，缩进的空格数为4个。
说明：对于由开发工具自动生成的代码可以有不一致。
程序块之间空行相对独立的程序块之间、变量说明之后必须加空行。
示例：如下例子不符合规范。
if (!valid_ni(ni)){... epssn_index;repssn_ni = ssn_data[index].ni;应如下书写if (!valid_ni(ni)){... epssn_index;repssn_ni = ssn_data[index].ni;长语句和长表达式较长的语句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。
示例：= 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));循环、判断等长表达式或语句循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。
示例：if ((taskno < max_act_task_number)&& (n7stat_stat_item_valid (stat_item))){... ord_length)&& (j < ; i++, j++){... . tat_object),sizeof (_STAT_OBJECT));n7stat_flash_act_duration( stat_item, frame_id *STAT_TASK_CHECK_NUMBER+ index, stat_object );短语句不允许把多个短语句写在一行中，即一行只写一条语句。
示例：如下例子不符合规范。
= 0; = 0;应如下书写= 0;= 0;条件、循环语句if、for、do、while、case、switch、default等语句自占一行，且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。
示例：如下例子不符合规范。
if (pUserCR == NULL) return;应如下书写：if (pUserCR == NULL){return;}语句对齐对齐只使用空格键，不使用TAB键。
说明：以免用不同的编辑器阅读程序时，因TAB键所设置的空格数目不同而造成程序布局不整齐，不要使用BC作为编辑器合版本，因为BC会自动将8个空格变为一个TAB键，因此使用BC合入的版本大多会将缩进变乱。
函数、过程和结构等语句块函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case语句下的情况处理语句也要遵从语句缩进要求。
程序块分界符程序块的分界符（如C/C++语言的大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。
在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。
示例：如下例子不符合规范。
for (...) {... .){... . .){... .){... . 前后不加空格。
p->id = pid; All manufacturing, reproduction, use,*//* and sales rights pertaining to this subject matter are governed by the *//* license agreement. The recipient of this software implicitly accepts *//* the terms of the license. *//* 本软件文档资料是xxx公司的资产,任何人士阅读和使用本资料必须获得*//* 相应的书面授权,承担保密责任和接受相应的法律约束. *//* *//**************************************************************************/说明性文件说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。
示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。