编程规范 | 关于头文件的几条规范

2023-05-16

665fbd76d584e1a1310cac5da7b832f8.png

一般来说,每一个.c或者.cpp文件对应一个头文件(.h文件),当然,也有例外,例如一些测试单元或者main文件,头文件的一些规范可以令代码可读性、程序的性能等大为改观,所以还是要注意头文件的规范问题。

一、#define保护

所有头文件为了防止文件被多重包含(multiple inclusion),一般就需要#define保护。#define保护的格式如下:

<PROJECT>_<PATH>_<FILE>_H_

例如:

#ifndef FOO_BAR_BARZ_H_
#define FOO_BAR_BARZ_H_

...

#endif //FOO_BAR_BARZ_H_

这个是比较老的一个做法了,所以很多编译器基本都是可以兼容的,但是还有另一个语句也是可以起到相同作用,但是一些太老的编译器据说用不了的(但是我好像没遇到过),VS下好像默认新建一个类的头文件就会用这个新的:

#program once

这一种相对于第一种的好处是,不通过#define一个变量来起到防止重复包含,所以,不存在重复变量的问题,#define后面的变量在同一个工程里是不能重复的,重复的话是只认一个的,就可能导致另一个文件编译的时候被排除。

二、头文件依赖

在头文件中减少包含其他头文件,改用前置声明(forward declarations),理由是:头文件被包含的同时会引入一项新的依赖(dependency),只要头文件被修改,代码就要重新编译,如果你的头文件包含了其它头文件,这些头文件的任何改动都将导致那些包含了你的头文件的代码重新编译。

使用前置声明就是在头文件中添加:

class Foo;

然后在对应的源文件中包含对应的头文件

#include <Foo.h>

可以这么做的几种情况:

1)、将数据声明为指针(Foo*)或者引用(Foo&);

2)、参数、返回值为Foo的函数只声明不定义;

3)、静态数据成员可以被声明为Foo,因为静态数据成员的定义在类定义之外;

但是,如果你的类是Foo的子类或者包含类型为Foo的非静态成员数据,则必须包含头文件。

补充说明,什么是声明,什么是定义,一般在头文件中经常看到一个函数,有返回值有输入参数,但是没有主体,或者一个变量声明为指针,但是没有new等操作,像这样的就是声明:

Foo *pFoo;
void setInputNumber(int num);

然后是定义,定义的话就是有函数主体,或者说就有变量的内存操作,包括非指针变量的声明也已经包含了定义,像这样的:

int nInputNumber;
int nCount = 0;
pFoo= new Foo();

void setInputNumber(int num)
{
    nInputNumber = num;
}

三、内联函数

当函数小于10行的时候可以定义为内联函数(inline function)。

定义:当函数被声明为内联函数后,编译器会将其内联展开,无需像通常的函数调用机制一样来调用内联函数。

优点:可以令目标代码更高效。适合存取函数或一些较短的关键代码。

缺点:滥用内联适得其反,内敛较大代码(如果编译器允许),将增加代码量;

不可用或者尽量不要用内联函数的情况:

1)、超过10行代码;

2)、析构函数;

3)、递归函数(可能大多数编译器不支持);

4)、包含循环或者switch语句的函数;

四、头文件包含实现代码

一般来说,头文件是只包含声明,而不要包含实现代码的,但是用到内联函数或者函数模板的话就需要将代码实现写在一起,为了可读性,是可以新建一个后缀为-inl.h的头文件,专门用于存放内联函数和模板函数,这样可以增强代码可读性。

需要注意,这样的头文件也要加#define保护的。

五、函数参数顺序(Function Parameter Ordering)

顺序:输入参数在前,输入输出参数居中,输出参数在后。

或者:输入参数在前,输入输出参数居中,输出参数在后,控制参数垫后。

输入参数一般为传值或者常数引用(const references),输出或者输入输出参数一般为传非常数指针(non-const pointers),有些参数是输入参数,但是属于控制变量意义的参数,那我是觉得应该放最后面的。

六、包含头文件顺序

如果我有一个命名为Foo.h的头文件以及一个对应的Foo.cpp的源文件,那么,头文件中的包含顺序应该是:

C库 > C++库 > 其他库的.h文件 > 项目内的.h文件;

而源文件中的包含顺序应该是:

#include "Foo.h" > C库 > C++库 > 其他库的.h文件 > 项目内的.h文件

还有一点强迫症的可以将同目录下的头文件按首字母顺序来排列。

补充说明,#include ""和#include <>的区别:

1)、#include <>引用的是编译器的类库路径里面的头文件;一般编译器会在编译器设置的include目录和系统中的INCLUDE环境变量中找头文件;一般用于标准文件;

2)、#include ""引用程序目录的相对位置的头文件;一般是先从当前文件所在的文件夹内找,找不到再去编译器设置的include目录或者系统的INCLUDE环境变量中找;一般用于自定义的文件。

结语

编程规范一方面是给机器看,提高代码的效率,另一方面也非常重要的用于给人看,提高人的效率。上述规范不一定就完全正确或者必须这么做,只是给个建议,看别人代码是超级累的一件事,简直想大呼这TM写的啥啊,何况更可怕的是看完发现这TM是我自己写的代码,想死的心都有了,利人终利己,就算出错了也好意思找别人帮忙看啊。

原文:https://www.cnblogs.com/Bearoom/p/11721800.html

版权归原作者所有,如有侵权,请联系删除。

3deee1393b1c409c79ef9ff28d087f16.png

1.嵌入式还有哪些风口值得入?

2.STM32和Arduino对比,谁更厉害?

3.嵌入式模块化编程、驱动分离的重要性

4.用CH573实现自拍杆蓝牙遥控器

5.带你一步一步理解C语言指针!

6.欧洲处理器项目第一阶段完成:29个RISC-V内核

78b8a1b010ec38bc4bfebaec0fce3545.gif

免责声明:本文系网络转载,版权归原作者所有。如涉及作品版权问题,请与我们联系,我们将根据您提供的版权证明材料确认版权并支付稿酬或者删除内容。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

编程规范 | 关于头文件的几条规范 的相关文章

  • 2019学习计划

    1 数据结构与算法 2 架构设计
  • ORB-SLAM(1) --- 让程序飞起来

    1 ORB SLAM简介 ORBSLAM是15年出的比较完备的单目slam算法 xff0c orb指的是一种旋转不变性特征 xff0c 整个算法均是基于orb特征实现的 xff0c 不同于基于稠密或半稠密地图的slam orbslam是一个
  • 再论文件系统

    2012 03 21 19 58 分类 xff1a File System 概述 关于 Linux 首先我们要了解的是其分区管理模式 xff0c 与 Windows 不同的是 Linux 是一个树形的目录结构 xff0c 无论怎么分区 xf
  • httpd服务器Failed to start httpd.service: Unit httpd.service is masked.解决办法

    当我们启动httpd服务的时候 xff0c 系统报错为 Failed to start httpd service Unit httpd service is masked 解决方法 xff1a systemctl unmask httpd
  • Python Pandas面试题及答案

    Pandas是一个开源库 xff0c 可在Python中提供高性能的数据处理 Pandas这个名称源自 面板数据 一词 xff0c 这表示来自多维数据的计量经济学 它可用于Python中的数据分析 xff0c 并由Wes McKinney在
  • podman简介

    podman简介掌握docker 跟上云时代的步伐 Podman是一个开源项目 xff0c 可在大多数Linux平台上使用并开源在GitHub上 Podman是一个无守护进程的容器引擎 xff0c 用于在Linux系统上开发 xff0c 管
  • 运维工程师从月薪 5K 到 50K,中间都经历了什么?

    做 运维 感觉像网管怎么办 xff1f 新工作运维3个多月 xff0c 天天就是维护重启服务器 xff0c 更新代码 感觉这样下去几年后就没有什么竞争力了 这是一个热门运维问题 xff0c 也是很多刚进入运维工作的同学面临的心境 确实 xf
  • Python初学者的自我修养,找到自己的方向

    Python初学者的自我修养 xff0c 找到自己的方向 对于我来说Python的应用场景主要是机器学习 深度学习相关 xff0c 对于其他的场景涉猎不多 因此本文的目的并不是列举出一系列小项目给你们练手 xff0c 而是希望引导大家思考这
  • 这100个shell脚本案例,你都知道吗?一篇教会你写90%的shell脚本

    shell 是一个应用程序 xff0c 它连接了用户和 Linux 内核 xff0c 让用户能够更加高效 安全 低成本地使用 Linux 内核 xff0c 这就是 Shell 的本质 shell脚本就是由Shell命令组成的执行文件 xff
  • 掌握它=掌握k8s!Kubernetes中文文档,学习提升看这一篇就足够

    Kubernetes又称 xff08 k8s xff09 xff0c 这几年可谓是非常的火热 xff0c Kubernetes让部署容器化的应用简单并且高效 xff0c 越来越多的程序员都想学习和掌握它来提高自己的效率 先来了解一下它的背景
  • Adaptive Autosar 整体架构理解

    1 总体说明 xff08 图片来源主要来源于Simulink 以及 Vector xff09 在Autosar官网 xff08 autosar org xff09 上 xff0c 目前CLASSIC PLATFORM 更新到4 4版本 xf
  • 244页Prometheus操作指南,内容详尽讲解细致

    Prometheus在监控工具中有多少话语权 xff1f 作为一款开源的监控工具 xff0c 早早地就在云原生计算基金会中毕业了 xff0c 如今已经成为了云原生应用的首选监控工具 xff0c 在国内外被广泛应用 Prometheus俨然已
  • 在 Linux 终端上的 10 个有趣的命令

    Linux 的命令行不仅是一个复杂且强大的命令所在地 xff0c 同时也是一个有趣的乐园 在本文中 xff0c 我整理了一系列有趣的 Linux 命令 xff0c 您可以从中获得乐趣 1 cmatrix 本列表中的第一个必须是 cmatri
  • 80篇+网络安全面试经验帖

    网络安全面试经验80篇 43 xff0c 看完妈妈再也不用担心我面试的问题了 汇总以下安全服务岗的面经 xff1a 渗透测试 红队攻防 代码审计 安全研究 红队开发 主要由两部分组成 xff1a 个人面试 互联网收纳整理 一 我的实习 am
  • Bash 中的 ${} 和 $() 有什么区别

    像 Linux 这样的基于 GNU 的操作系统依赖于一个名为 Bash 的命令语言解释器或 Shell 来完成它们的大部分计算任务和目标 Bash 是 Bourne Again Shell 的缩写 xff0c Bunne Again She
  • Go 服务端开发,请牢记这几条

    服务端开发一般是指业务的接口编写 xff0c 对大部分系统来说 xff0c 接口中CURD的操作占了绝大部分 然而 xff0c 网络上总有调侃 CURD工程师 的梗 xff0c 以说明此类开发技术并不复杂 但我个人认为 xff0c 如果仅仅
  • 域格4G模块串口开机自动透传的使用

    首先要求是模块版本为串口自动透传版本 1 模式切换 从透传模式切换至临时指令模式的时序 xff1a 1 串口设备给模块 连续发送 43 43 43 xff0c 模块收到 43 43 43 后 xff0c 会给串口设备发送一个 a 在发送 4
  • 网红送餐无人车冒充AI,真人海外远程操控

    美国网红外卖机器人Kiwibot实际由远在南美哥伦比亚的真人远程操控 xff0c 每人时薪不到2美元 xff0c 最多控制三台 2017年成立的Kiwi Campus公司累计获得200万美元融资 xff0c 约人民币1414万元 xff0c
  • 国产开源基础软件MiniGUI宣布支持RT-Thread!

    北京飞漫软件技术有限公司宣布 xff1a 将在 MiniGUI 4 0 2 版本中支持国产操作系统 RT Thread xff01 这是自 MiniGUI 创始人魏永明在本月初宣布启动 1998 年年底 xff0c 魏永明开始在清华大学开发
  • 既然C编译器是C语言写的,那第一个C编译器是怎样来的?

    来源 xff1a 伯乐在线 xff0c 作者 xff1a Chaobs 首先向C语言之父Dennis Ritchie致敬 xff01 当今几乎所有的实用的编译器 解释器 xff08 以下统称编译器 xff09 都是用C语言编写的 xff0c

随机推荐

  • Oracle推出全球首个自治操作系统~

    原创 xff1a 程序员的那些事 xff08 id xff1a iProgrammer xff09 导读 xff1a 保持系统的修补和安全是 IT 部门目前面临的最大挑战之一 在大规模云环境中 xff0c 此类任务乏味 容易出错 xff0c
  • 基于Autosar的网络安全理解

    目录 1 车载网络安全说明 2 常用的安全加密算法 2 1 对称加密 2 2 非对称加密 2 3 混合加密 2 4 单向散列函数 2 5 消息认证码 2 6 数字签名 3 Autosar的加密模块 3 1 模块说明 3 2 关键数据流说明
  • Linux实用程序——Make快速入门

    1 Make make 是 linux 系统的实用程序 它用于管理对于大型程序的自动编译任务 xff0c 自动决定程序某一部分需要重新编译 xff0c 并发出编译指令 虽然 xff0c 我们最常见于 C 语言程序的编译 但是 xff0c m
  • 干货!学习STM32的一些经验分享

    前言 前两天在群里看到群友们在讨论学习STM32的话题 xff0c 并且今天也有一位机械专业的准研究生读者也问了STM32的入门问题 正好我也有一点点经验 xff0c 所以试着分享一下这个话题 我也不是什么大神 xff0c 只是一名普通的工
  • 为什么买了开发板只能吃灰,还是学不会嵌入式?

    经常有同学问我 xff1a 老师 xff0c 我想学嵌入式 xff0c 应该买哪个板子 xff1f 这个问题本身就是错的 如果你去问10个买过开发板的人 xff0c 至少有8个最终都吃灰了 xff0c 而且他也没通过这个板子以及板子附带的所
  • 基于LiteOS的智慧农业案例实验分享!

    最近在指导一位读者朋友做毕业设计 xff0c 该毕设是关于端云互通的 xff0c 基于小熊派 43 LiteOS 43 华为云 在指导他的过程中我也学到了不少东西 xff0c 这里通过一个案例实验 xff08 智慧农业 xff09 给大家分
  • 漫谈C变量—为什么嵌入式项目中常用静态变量?

    在C语言中 xff0c 按照生命周期来分 xff0c 变量只有两类 xff1a 静态变量和动态变量 其中 xff0c 静态变量是指 xff0c 在编译时刻 xff08 Compiling time xff09 变量的地址和大小都已经确定下来
  • 10月1日后,GitHub用main替代master

    转自 xff1a 开源中国 GitHub 官方表示 xff0c 从 2020 年 10 月 1 日起 xff0c 在该平台上创建的所有新的源代码仓库将默认被命名为 34 main 34 xff0c 而不是原先的 34 master 34 值
  • C++在嵌入式中表现如何?

    这是知乎嵌入式领域的一个热门话题 xff0c 原文链接 xff1a https www zhihu com question 374663834 几个高赞回答 xff1a idea4good xff1a 先说结论 xff1a 嵌入式 单片机
  • 选微处理器MPU,还是单片机MCU?

    每项新应用设计都需要一个单片机或微处理器 当在两者之间选择其一时 xff0c 需要考虑一些因素 以下是微处理器 单片机的概述和对比 考虑选择微处理器 MPU 或者单片机 MCU 时 xff0c 应用类型通常是关键因素 另一方面 xff0c
  • 图解FreeRTOS 原理系列之任务管理器基本框架!

    导读 学习梳理一下FreeRTOS任务管理单元实现思路 xff0c 代码分析基于V10 4 3 从本文开始计划写个图解freeRTOS内核系列笔记分享给朋友们 xff0c 希望大家喜欢 本文主要学习梳理FreeRTOS任务管理器的基本原理
  • 一文带你快速理解FreeRTOS代码规范~

    导读 遇到些朋友感觉FreeRTOS内核代码看起来很不习惯 xff0c 不习惯其编码风格 xff0c 本文就来梳理一下其代码规范 xff0c 便于提高阅读其代码的效率 代码基于FreeRTOS V10 4 3 FreeRTOS代码结构 其内
  • [Adaptive Autosar]深入理解--Persistency

    目录 1 Per架构 2 Per初始化 3 Per错误处理 4 多进程访问 5 冗余存储 6 安装和更新per数据 7 Key Value 方式 8 file storage 方式 9 典型使用代码 Persistency模块对比 CP 中
  • 用Excel教会你PID算法!

    01 引入PID 电机控制 这样是没有反馈的 xff0c 也就是说我们完全相信输入的数字 xff0c 且是理想化的模型 xff0c 比如输入占空比为50 的25Kz的PWM xff0c 车轮速度为1m s xff0c 实际产品中会受到各种这
  • 带你快速理解FreeRTOS的代码规范~

    导读 遇到些朋友感觉FreeRTOS内核代码看起来很不习惯 xff0c 不习惯其编码风格 xff0c 本文就来梳理一下其代码规范 xff0c 便于提高阅读其代码的效率 代码基于FreeRTOS V10 4 3 FreeRTOS代码结构 其内
  • 单片机串口最底层的本质​!

    嵌入式开发中 xff0c UART串口是最常见的一种通信接口 xff0c 你知道为啥串口这么常见吗 xff1f 本文就带你深入了解串口最底层的本质内容 一 什么是串口通讯 xff1f 串行通讯是指仅用一根接收线和一根发送线就能将数据以位进行
  • 一个本科生学习嵌入式的心得~

    为毕业后能找到工作而读书 xff0c 本着务实精神 xff0c 从入学那一刻起就要开始准备找工作了 发这篇文章主要是针对大学刚接触嵌入式的同学 很多新手觉得嵌入式入门并不容易 xff0c 牵扯的内容 知识点太多 像C语言基础是否掌握 xff
  • 使用 Rust 进行嵌入式开发

    作者 xff1a RT Thread社区团队 liukang 原文链接 xff1a https club rt thread org ask article 2944 html Rust 是什么 Rust 是一门赋予每个人构建可靠且高效软件
  • STM32的SPI外设片选只有一个,怎么破?

    之前用STM32的SPI需要控制很多外部芯片 xff0c 可是一个SPI的外设只有一个片选 xff0c 要实现独立片选一主多从 xff0c 怎么实现呢 xff1f SPI总线拓扑 一般地 xff0c SPI总线按照下图方式进行连接 xff0
  • 编程规范 | 关于头文件的几条规范

    一般来说 xff0c 每一个 c或者 cpp文件对应一个头文件 h文件 xff0c 当然 xff0c 也有例外 xff0c 例如一些测试单元或者main文件 xff0c 头文件的一些规范可以令代码可读性 程序的性能等大为改观 xff0c 所