#include＜*.h＞与const不可变性的关联

对于#include <.h>与#include ".h"的惯用法

1. #include <*.h>用来包含系统头文件

2. #include "*.h"用来包含自研模块内头文件

更精深的区别，则可以在C语言标准中找寻，但也仅是一个框架限制

简而言之，#include <.h> 和 #include ".h" 都会在实现定义的位置查找文件，并将其包含。区别是，若 #include ".h" 可以查找成功，则遮蔽 #include <.h> 所能找到的同名文件；否则,若 #include ".h" 查找失败，再转换为 #include <.h> 的方式查找头文件。另外，标准库头文件，都放在 #include <*.h> 所查找的位置。

---

在两种引用头文件方式的不同之中，我看重的倒是#include <*.h>与#include "*.h"一划开天地的区分能力

• 头文件引用位置不同

  • <*.h>通常引用系统或第三方添加库的头文件
  • "*.h"通常引用模块内开发头文件

• 头文件引用表达的可变性不同

  • <*.h>引用通常表达仅使用其提供的API
  • “*.h”因使用模块内的头文件，通常可以变更其头文件定义和实现代码，较易办到

所以，在我们见到如此代码模板的时间，将会有更清晰地感觉

//引用系统头文件
#include <[sys/]*.h>

//引用附加库头文件
#include <[additional_lib/]*.h>

//引用开发模块内头文件
#include "[self/]*.h"

int main(void)
{
...
}

---

在近来的编码实践中，非常喜欢用const来描述c语言API接口的可变性。在这点上与#include <>与#include “”表达可变性的能力上有异曲同工之妙

int newcopy(void* dst, void* src, size_t len)

VS

int newcopy(void* dst, const void* src, size_t len)

注：API 清晰地表达，仅对dst变更的概念；而且从编译层面，限制了对src参数的意外修改

---

结束语

对于熟悉代码的人，一眼望去，可能就能够明白一些设计上的区分。但，如果代码是以人为本的话，使用一看即明白的写法，既增加了代码对新手的可理解性，又减轻了代码对老鸟的记忆负担 ：）