华为公司代码规范
转于http://blog.sina.com.cn/s/blog_61176a740100ffer.html
内容简要:写代码习惯以及注释的要求。

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:不允许把多个短语句写在一行中,即一行只写一条语句。
示例:如下例子不符合规范。
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 (...) {
... // 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-1:一行程序以小于80字符为宜,不要写得过长。

2 注释
2-1:一般情况下,源程序有效注释量必须在20%以上。
说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。
2-2:说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。
示例:下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。

2-3:源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。
示例:下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。

说明:Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。History是修改历史记录列表,每条修改记录应包括修改日期、修改者及修改内容简述。
2-4:函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。
示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。

2-5:边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。
2-6:注释的内容要清楚、明了,含义准确,防止注释二义性。
说明:错误的注释不但无益反而有害。
2-7:避免在注释中使用缩写,特别是非常用缩写。
说明:在使用缩写时或之前,应对缩写进行必要的说明。
2-8:注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。
示例:如下例子不符合规范。

repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;

应如下书写

2-9:对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。
示例:

2-10:数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。
示例:可按如下形式说明枚举/数据/联合结构。

2-11:全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
示例:

转载于:https://www.cnblogs.com/LyndonMario/p/8149876.html

代码规范之华为公司代码规范相关推荐

  1. 华为公司 代码编码规范

    原文链接:http://blog.sina.com.cn/s/blog_61176a740100ffer.html 1-1:程序块要采用缩进风格编写,缩进的空格数为4个. 说明:对于由开发工具自动生成 ...

  2. 华为编程规范_华为 Java 编程规范出炉,究竟和官方文档有何不同?

    来源:blog.csdn.net/chenleixing/article/details/44173985 1.引言 这个标准是衡量代码本身的缺陷,也是衡量一个研发人员本身的价值.华为作为一家全球化的 ...

  3. 项目测试流程规范(不同公司流程规范不一样,仅供参考)

    前言:结合公司的项目情况制定合理的测试流程,提高测试效率和产品质量.核心还是要加强项目成员之间的沟通,在保障研发效率的前提下提高产品质量. 一.测试流程图 上述流程图为项目的测试流程图,每家公司用的项 ...

  4. 项目线上问题应急处理规范(不同公司流程规范不一样,仅供参考)

    前言:整理了一下项目线上问题应急处理规范,仅供参考! 1.1线上报障流程 1.2.目的 为了明确线上事件的报告.应急响应和处理机制,确保能以快速.高效.准确的应急处理能力来保证各类系统的正常运转,当发 ...

  5. 公司代码与采购组织的分配关系

    第一种 特定工厂的采购组织plant-specific purchasing organization 将一个工厂分配给一个公司代码,而一个公司代码就分配给一个采购组织,创建采购订单时,输入采购组织, ...

  6. 复制公司代码后更改会计科目表(OB62),报错:更改会计科目表前重置公司码数据-OBR1/OBR2

    文章目录 一.更改会计科目表,报错 二.解决方法 2.1 重置业务数据-OBR1 2.1.1 使用注意事项及设置-OBR3 2.2 删除科目-OBR2 2.3 验证是否解决 一.更改会计科目表,报错 ...

  7. 【SAP】公司代码与采购组织的分配关系

    第一种 特定工厂的采购组织plant-specific purchasing organization 将一个工厂分配给一个公司代码,而一个公司代码就分配给一个采购组织,创建采购订单时,输入采购组织, ...

  8. SAP 公司代码与采购组织的分配关系

    第一种 特定工厂的采购组织plant-specific purchasing organization 将一个工厂分配给一个公司代码,而一个公司代码就分配给一个采购组织,创建采购订单时,输入采购组织, ...

  9. 公司公司代码业务范围成本控制范围概念

    1. 公司(Company)复杂的组织日益需要一个全景式的会计报表,这种趋势在当今竞争日趋激烈的经济全球化进程中显得越来越重要.SAP R/3系统中定义的集团公司的组织结构元素,可以是实际的或虚拟存在 ...

最新文章

  1. linux sar 命令详解
  2. Hadoop运行模式 之 伪分布式运行模式
  3. 机器学习流程模板及多模型对比实战梳理
  4. 在幕后看看Swift中的Map,Filter和Reduce的实现
  5. 如何恢复matlab关联,恢复matlab文件关联
  6. Netty - 传输
  7. 几种流行Webservice框架性能对照
  8. c语言学习-判断101-200之间有多少个素数,并输出所有素数及素数的个数
  9. RocketMQ集群详解
  10. 基于耗散性的matlab,基于耗散能的沥青抗老化性能评价方法与流程
  11. MySql递归查询上级,下级
  12. java 回溯法总结,回溯算法(JAVA)
  13. Oracle LiveLabs实验:Application Continuity Fundamentals
  14. Python--正则表达式处理文本
  15. buctoj2021年ACM竞赛班训练(七)题解
  16. os.listdir()详解
  17. 字符串判断相等和不相等
  18. VMware的 Mount虚拟光驱问题
  19. 浅谈TC10休眠唤醒规范
  20. python集合是什么意思_Python集合是什么,为什么应该使用以及如何使用?

热门文章

  1. nohup使得Python web项目在服务器上后台运行
  2. python ini文件操作
  3. 解决selenium用cookies时候报错selenium.common.exceptions.InvalidArgumentException: Message: invalid argument
  4. Javascript模块化编程
  5. android 蓝牙低耗能(LBE)技术介绍
  6. Spark系列(八)Worker工作原理
  7. Hello World!!
  8. ERP笔记2-善用SVN对系统环境进行配置和组织
  9. 对软件测试工程师面试题目的回答[转]
  10. 数据结构第二章学习总结