时间戳

首页 > 解决方案 > c-module 有多少个头文件？

c - c-module 有多少个头文件？

问题描述

我的项目中有一个模块，mymodule.c它为我的项目的其余部分提供了很多功能。这些函数在mymodule.h头文件中定义。

但是mymodule.c还有很多其他定义或定义掩码。

例如：

#define STACKSIZE 1024
#define TIMER1    100
#define TCR_MASK  16U
#define TCR       16U
#define TCR_IR    (0ULL << 8)
...
100 other defines or typedefs

我可以这样拆分：

mymodule.h --->从其他地方使用的所有外部函数和声明。将此重命名为mymodule_public.h?

mymodule_config.h---> 配置，如定时器、控制参数或常量。

mymodule_masks.h ---> 描述符。

可能有更多的标题。

另一种方法是将除外部函数之外的所有函数都保留在mymodule.c.

拆分为标题并给出标题名称的最佳实践是什么？

标签： c

解决方案

通常，作为库的公共接口的头文件应该包含调用者使用函数所需的所有内容。

如果你有一堆#define是使用这些函数所必需的，它们需要在 h 文件中。如果它们不需要但只是在内部使用，则应将它们保存在 c 文件中。

可以制作第二个头文件，它不是公共 API，但只包含 c 文件使用的内部常量。

至于在哪里放置#include，这有点主观。一般来说，我喜欢向库的用户展示该库附带的依赖项，以便他们可以确保他们拥有所有必要的文件，并且他们可以更轻松地解决奇怪的链接器错误。另一方面，人们可能会对“公开”库在公共标头中私下使用的包含感到不安（例如上面提到的第二个私有标头）。这里没有明显的对错，但尽量与放置#includes 的位置保持一致。

您使用多个标头的想法都以某个特定于库的前缀“mymodule”命名，总体而言非常合理。

推荐阅读