华为C语言编程规范总结

1.头文件更改会导致所有直接或间接包含该头文件的的C文件重新编译,会增加大量编译工作量,延长编译时间,因此:
    1.1 头文件里尽量少包含头文件
    1.2 头文件应向稳定的方向包含

2.每一个.c文件应有一个同名.h文件,用于声明需要对外公开的接口

3.所有头文件都应当使用#define 防止头文件被多重包含,命名格式为FILENAME_H,为了保证唯一性,更好的命名是PROJECTNAME_PATH_FILENAME_H。注意最前面没有'_'或'__',因为一般以单下划线"_"和双下划线"__"开头的标识符为ANSI C等使用

4.只能通过包含头文件的方式使用其他.c提供的接口,禁止在.c中通过extern的方式使用外部函数接口、变量

5. 一个模块通常包含多个.c文件,建议放在同一个目录下,目录名即为模块名。为方便外部使
用者,建议每一个模块提供一个.h,文件名为目录名

6.避免函数过长,新增函数不超过50行(非空非注释行),过长的函数往往意味着函数功能不单一,过于复杂

7.避免函数的代码块嵌套过深,新增函数的代码块嵌套不超过4层

8.在带操作系统编程时,全局变量和静态变量都属于共享资源,在使用时都得做互斥处理,因此函数中尽量少使用全局变量和静态变量,一旦使用将会使该函数的可重入性大大降低

9.设计高扇入,合理扇出(小于7)的函数,扇出表示该函数内部调用其它函数的数目

10.标识符命名规则建议使用unix like风格:单词用小写字母,每个单词直接用下划线„_‟分割,例  如text_mutex

11.文件命名统一采用小写字符,因为不同系统对文件名大小写处理会不同(如MS的DOS、Windows系统不区分大小写,但是Linux系统则区分)

12.全局变量应增加“g_”前缀,静态变量应增加“s_”前缀

13. 一个变量只有一个功能,不能把一个变量用作多种用途

14.建议定义一个STATIC宏,在调试阶段,将STATIC定义为static,版本发布时,改为空,以便于后续的打补丁等操作。

15.用宏定义表达式时,要使用完备的括号,如#define RECTANGLE_AREA(a, b) a * b 应该定为         #define RECTANGLE_AREA(a, b) ((a) * (b))

16.当宏定义中涉及多个表达式时,最好用do{}while(0)包含

17.使用宏和函数时,不允许参数发生变化,如:
    #define SQUARE(a) ((a) * (a))
    int a = 5;
    int b;
    b = SQUARE(a++); // 结果:a = 7,即执行了两次增

18.除非必要,应尽可能使用函数代替宏

19.常量建议使用const定义代替宏:“尽量用编译器而不用预处理”,因为#define经常被认为好象不是语言本身的一部分;宏定义的标志字符/符号编译器是看不到的,因为已经被预处理器处理掉了,所以在编译报错或调试时是完全看不到这个符号的,如定义了一个数字,你只看得到数字本身,因此很不利于调试

20.代码质量保证优先原则 
(1)正确性,指程序要实现设计要求的功能。
(2)简洁性,指程序易于理解并且易于实现。
(3)可维护性,指程序被修改的能力,包括纠错、改进、新需求或功能规格变化的适应能力。
(4)可靠性,指程序在给定时间间隔和环境条件下,按设计要求成功运行程序的概率。
(5)代码可测试性,指软件发现故障并隔离、定位故障的能力,以及在一定的时间和成本前提下,进
行测试设计、测试执行的能力。
(6)代码性能高效,指是尽可能少地占用系统资源,包括内存和执行时间。
(7)可移植性,指为了在原来设计的特定环境之外运行,对系统进行修改的能力。
(8)个人表达方式/个人方便性,指个人编程习惯。

21.禁止内存操作越界,尤其在使用字符串时,字符串默认都是以'\0'(即0x00)结尾的,在使用/操作字符串时,注意有没有'\0'结尾,建议使用限制字符数量的字符串操作函数代替一些危险函数,如:用strncpy()代替strcpy();用strncat()代替strcat();用snprintf()代替sprintf()

22.禁止内存泄漏,如忘记释放内存

23.对于多维大数组,避免来回跳跃式访问数组成员。

24.优秀的代码可以自我解释,不通过注释即可轻易读懂。优秀的代码不写注释也可轻易读懂,注释无法把糟糕的代码变好,需要很多注释来解释的代码往往存在坏味道,需要重构。

25.文件头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者姓名、工号、内
容、功能说明、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。

26.全局变量要有较详细的注释,包括对其功能、取值范围以及存取时注意事项等的说明。

27.注释应考虑程序易读及外观排版的因素,使用的语言若是中、英兼有的,建议多使用中文
除非能用非常流利准确的英文表达。对于有外籍员工的,由产品确定注释语言。

28.多个短语句(包括赋值语句)不允许写在同一行内,即一行只写一条语句

29.if、for、do、while、case、switch、default等语句独占一行

30.产品代码中经常有如下代码:

int foo()
{if (异常条件) { 异常处理;return ERR_CODE_1;}if (异常条件){ 异常处理;return ERR_CODE_2;}正常处理;return SUCCESS;
}
这样的代码看起来很清晰,而且也避免了大量的 if else 嵌套。但是从性能的角度来看,应该把执行概 率较大的分支放在前面处理,由于正常情况下的执行概率更大,若首先考虑性能,应如下写:
int foo()
{ if (满足条件) { 正常处理; return SUCCESS; } else if (概率比较大的异常条件) { 异常处理;return ERR_CODE_1; } else{ 异常处理;return ERR_CODE_2; } 
}
除非证明 foo 函数是性能瓶颈,否则按照本规则, 应优先选用前面一种写法
记住: 让一个正确的程序更快速,比让一个足够快的程序正确,要容易得太多 。大多数时候,不要把 注意力集中在如何使代码更快上,应首先关注让代码尽可能地清晰易读和更可靠。
31.赋值语句不要写在if等语句中,或者作为函数的参数使用;因为if语句中,会根据条件依次判断,如果前一个条件已经可以判定整个条件,则后续条件语
句不会再运行
32.用括号明确表达式的操作顺序,避免过分依赖默认优先级。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/pingmian/66849.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

Dependency check 通过Maven构建时,配置Mysql数据库遇到的三个坑

使用过Dependency check的同学,一定会遇到这个问题—— 每次执行依赖扫描时,由于网络问题会导致NVD下载种子数据的过程中的种种失败,不仅浪费了大量时间,还会因为下载文件的不完整性直接导致依赖检测的失败。所以我在使用Dependen…

【面试题】技术场景 5、日志采集ELK

日志采集的重要性与采集方式 重要性:在项目开发、测试及生产环境中,日志是定位系统问题的关键手段,对系统维护与问题排查至关重要。采集方式 常规采集:按天保存日志文件至专门目录,文件名包含项目名、端口及日期&…

【数据库】三、SQL语言

文章目录 三、SQL语言1 概述2 数据定义(DDL)2.1 定义数据库2.2 定义基本表2.3 修改基本表2.4 删除基本表 3 数据操作(DML)3.1 数据查询3.1.1 单表查询3.1.2 连接查询3.1.3 嵌套查询3.1.4 集合查询 3.2 数据更新3.2.1 插入数据3.2.2 修改数据3.2.3 删除数据 4 数据控制(DCL)5 视…

Unity中 Xlua使用整理(二)

1.Xlua的配置应用 xLua所有的配置都支持三种方式:打标签;静态列表;动态列表。配置要求: 列表方式均必须是static的字段/属性 列表方式均必须放到一个static类 建议不用标签方式 建议列表方式配置放Editor目录(如果是H…

Python Matplotlib教程-Matplotlib 多子图布局

Python Matplotlib 多子图布局 Matplotlib 是 Python 中最常用的数据可视化库,它提供了强大的功能来绘制不同类型的图表。在实际应用中,通常需要将多个图表绘制在同一个画布上,这就需要用到 多子图布局。本篇文章将详细介绍如何使用 Matplot…

全方位解读消息队列:原理、优势、实例与实践要点

全方位解读消息队列:原理、优势、实例与实践要点 一、消息队列基础认知 在数字化转型浪潮下,分布式系统架构愈发复杂,消息队列成为其中关键一环。不妨把消息队列想象成一个超级“信息驿站”,在古代,各地的信件、物资运…

Photon最新版本PUN 2.29 PREE,在无网的局域网下,无法连接自己搭建的本地服务器

1.图1为官方解答 2.就是加上这一段段代码:PhotonNetwork.NetworkingClient.SerializationProtocol SerializationProtocol.GpBinaryV16; 完美解决 unity 商店最新PUN 2 插件 不能连接 (环境为:本地局域网 无外网情况 ) …

消息中间件类型介绍

消息中间件是一种在分布式系统中用于实现消息传递的软件架构模式。它能够在不同的系统或应用之间异步地传输数据,实现系统的解耦、提高系统的可扩展性和可靠性。以下是几种常见的消息中间件类型及其介绍: 1.RabbitMQ 特点: • 基于AMQP&#…

51单片机(二)中断系统与外部中断实验

中断即单片机因为某些原因E暂定现在的工作P0,转去做其他的工作P1,完了之后继续之前的事P0,其他工作P1就是中断程序,原因E就是中断事件,原因由外部发生,程序不能预测到的是硬中断,可以由程度触发…

python-42-使用selenium-wire爬取微信公众号下的所有文章列表

文章目录 1 seleniumwire1.1 selenium-wire简介1.2 获取请求和响应信息2 操作2.1 自动获取token和cookie和agent2.3 获取所有清单3 异常解决3.1 请求url失败的问题3.2 访问链接不安全的问题4 参考附录1 seleniumwire Selenium WebDriver本身并不直接提供获取HTTP请求头(header…

汽车信息安全 -- S32K1如何更新BOOT_MAC

目录 1.安全启动模式回顾 2.为什么要讨论BOOT_MAC 3.S32K1如何更新? 1.安全启动模式回顾 之前提到过,S32K1系列提供了Crypto Service Engine硬件加密模块(简称CSEc),大家可以通过该芯片系统寄存器SDID.FEATURES(System Device Identification Register)来判断自己的片子…

【Python】Python与C的区别

文章目录 语句结束符代码块表示变量声明函数定义注释格式Python的标识符数据输入input()函数数据输出print()函数 语句结束符 C 语言 C 语言中每条语句必须以分号;结束。例如,int a 10;、printf("Hello, World!");。分号是语句的一部分,用于…

理解Unity脚本编译过程:程序集

https://docs.unity3d.com/Manual/script-compilation.html 关于Unity C#脚本编译的细节,其中一个比较重要的知识点就是如何自定义Assembly。 预定义的assembly 默认情况下,Unity会按照这个规则进行编译。 PhaseAssembly nameScript files1Assembly-…

Linux内核TTY子系统有什么(6)

接前一篇文章:Linux内核TTY子系统有什么(5) 本文内容参考: Linux TTY子系统框架-CSDN博客 一文彻底讲清Linux tty子系统架构及编程实例-CSDN博客 linux TTY子系统(3) - tty driver_sys tty device driver-CSDN博客 Linux TTY …

《代码随想录》Day31打卡!

《代码随想录》贪心算法:合并区间 本题的完整题目如下所示: 本题的完整思路如下所示: 1.本题依然是先对数组的左边界进行排序。将数组的第一个元素赋值给current。 2.遍历数组,判断current中的右边界和当前元素的左边界是否有重叠…

KL 散度:多维度解读概率分布间的隐秘 “距离”

深入理解KL散度:从多维度全面剖析 损失函数相关文章(置顶) 1. KL 散度:多维度解读概率分布间的隐秘 “距离” 2. 熵与交叉熵:从不确定性角度理解 KL 散度 3. 机器学习、深度学习关于熵你所需要知道的一切 引言 KL散即…

node-sass@4.14.1报错的最终解决方案分享

输入npm i全安装文件所需的依赖的时候,博主是使用sass去书写的,使用的是node-sass4.14.1和sass-loader7.3.1的版本的,安装的时候老是出现错误, node-sass4.14.1版本不再被支持的原因 node-sass 是一个基于 LibSass 的 Node.js 绑…

设计模式(观察者模式)

设计模式(观察者模式) 第三章 设计模式之观察者模式 观察者模式介绍 观察者模式(Observer Design Pattern) 也被称为发布订阅模式 。模式定义:在对象之间定义一个一对多的依赖,当一个对象状态改变的时候…

PyCharm 的安装与使用(Window)

1 PyCharm 简介 PyCharm 是一款由 JetBrains 公司开发的专门用于 Python 语言开发的集成开发环境(IDE)。以下是其相关介绍: 1.1 特点与功能 智能代码编辑:提供高度智能化的代码编辑器,支持语法高亮、自动补全、代码重…