编码规范
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源文件内容片段按如下顺序,文件注释-包含头文件-宏定义-数据结构定义-变量定义-引用外部变量-引用外部函数-本地函数-全局函数。
声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。
举报投诉
-
嵌入式
+关注
关注
5082文章
19115浏览量
304951 -
编码
+关注
关注
6文章
942浏览量
54821 -
函数
+关注
关注
3文章
4329浏览量
62586
发布评论请先 登录
相关推荐
嵌入式Linux C代码规范化
本文档为作者 在嵌入式和嵌入式 linux C语言的学习和工作中所总结的代码规范 ,是作者从 STM32单片机开发向 Linux C开发的时
发表于 01-14 10:25
嵌入式软件开发编程规范及原则
编程规范也就是编写出简洁、可维护、可靠、可测试、高效、可移植的代码,提高产品代码的质量。本文针对嵌入式,主要结合C语言编程的规范给大家讲述。
嵌入式系统的规范发展回顾
后PC时代,嵌入式系统的发展风起云涌,波澜壮阔。在这一历史洪流中,众多的嵌入式系统规范争奇斗艳,各种嵌入式板卡令人眼花缭乱。伴随着极大量标准软硬件产品的支持,
发表于 02-14 14:00
•1649次阅读
慕课嵌入式开发及应用(第二章.嵌入式硬件构件与底层驱动构件基本规范)
慕课苏州大学.嵌入式开发及应用.第二章.入门与软件框架.嵌入式硬件构件与底层驱动构件基本规范0 目录2 入门与软件框架2.1 嵌入式硬件构件与底层驱动构件基本
发表于 10-19 18:33
•8次下载
【嵌入式】文件操作
()、fcntl()等函数的使用;熟悉嵌入式系统挂载U盘通信。利用文件操作函数实现对文件的操作,通过交叉编译生产可执行文件,由嵌入式系统控制
发表于 10-20 15:21
•1次下载
【嵌入式】构建嵌入式Linux系统(uboot、内核、文件系统)
嵌入式Linux系统知识架构及层次嵌入式Linux系统构成及启动略析嵌入式Linux三剑客之uboot技术嵌入式Linux三剑客之内核技术嵌入式
发表于 10-20 18:20
•42次下载
评论