编码规范
2.1 文件头申明
◎ 新增.c必须添加注释,标注公司名称、文件功能说明,创建日期、作者,后续修改说明 范例如下:
/*********************************************************************
* Copyright (c) Hehe,Ltd. All rights reserved.
* Description:用于详细说明此程序文件完成的主要功能,
* 与其他模块或函数的接口依赖等关系
*
* History:修改历史记录列表,包括修改日期、修改者及修改内容简述
* Date Author Modification:
* 2023-11-25 embedded-system create v1.0
*********************************************************************/
可配置Source Insight 自动生成模板。
2.2 文件
◎ 所有.h头文件必须采取阻止内容被包含多于一次的机制
#ifndef __XXX__
#define __XXX__
#endif /*__XXX__*/
◎ 头文件对外接口,应放置对外部的声明,如对外提供的函数声明、宏定义、类型定义等。
◎ 内部使用的函数声明不应放在头文件中。
◎ 内部使用的宏、枚举、结构定义不应放入头文件中。
◎ 变量定义禁止在头文件中,应放在.c文件中。
◎ 模块内使用的全局变量,不应通过在头文件中声明的方式直接暴露给外部。
◎ 头文件中只包含接口的声明,不含实现。
◎ 头文件应当职责单一,头文件过于复杂,依赖过于复杂是导致编译时间过长的主要原因。
◎ 每一个.c文件应有一个同名.h文件,用于声明需要对外公开的接口。
◎ 禁止头文件循环依赖,禁止包含用不到的头文件。
◎ 每个.c源文件内容片段按如下顺序,文件注释-包含头文件-宏定义-数据结构定义-变量定义-引用外部变量-引用外部函数-本地函数-全局函数。
声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。
举报投诉
-
嵌入式
+关注
关注
5017文章
18495浏览量
293070 -
编码
+关注
关注
6文章
836浏览量
54531 -
函数
+关注
关注
3文章
4117浏览量
61547
发布评论请先 登录
相关推荐
![](https://file1.elecfans.com/web2/M00/85/A2/wKgZomRmN8eAAH-OAAGS5yhZ_OM616.png)
![](https://file1.elecfans.com/web2/M00/85/A2/wKgZomRmN8eAAH-OAAGS5yhZ_OM616.png)
![](https://file1.elecfans.com/web2/M00/85/A2/wKgZomRmN8mAXd9wAAG4B1V21Qo189.png)
嵌入式C/单片机C/标准C知识点
深圳发烧友嵌入式实训学院总结了一些C语言的知识点: 仅供大家参考,想一起和我讨论吗,可以加一下我的QQ1187729241,dong老师 一、嵌入式C/单片机
发表于 10-24 14:42
嵌入式Linux应用程序开发标准教程
Linux下C编程基础第4章 嵌入式系统基础第5章 文件IO编程第6章 进程控制开发第7章 进程间通信第8章 多线程编程第9章 嵌入式Linux网络编程第10章
发表于 05-07 15:40
嵌入式小波编码算法的原理是什么?
在基于小波变换的图象压缩方案中,嵌入式零树小波 EZW(Embedded Zerotree Wavelets)[1]编码很好地利用小波系数的特性使得输出的码流具有嵌入特性。近年来,在对EZW改进
发表于 08-15 08:27
嵌入式Linux C代码规范化
本文档为作者 在嵌入式和嵌入式 linux C语言的学习和工作中所总结的代码规范 ,是作者从 STM32单片机开发向 Linux C开发的时
发表于 01-14 10:25
什么叫嵌入式 嵌入式应用
防、智能农业工控类:机械手臂、医疗用具3、嵌入式开发框架:Linux开发:c语言——>编译文件(二进制)——>下载到操作系统——>运行4、c语言框架头
发表于 08-12 07:51
嵌入式C语言进阶之道
之间分工合作,你 要学会模块化编程、要写出更规范更安全的代码、做更合理的优化、减少更多的 bug。所有 的这些,都迫使你必须更彻底的理解嵌入式 C 的语法结构,数据细节,与硬件打交道的特 性,使得你
发表于 04-19 10:15
评论