为什么C语言开发建议在函数定义的源文件中引入含其原型的头文件

涉及代码示例 #

file1.c #

#include <stdio.h>
#include "file2.h"

int main(void){
    printf("%s:%s:%d \n", __FILE__, __FUNCTION__, __LINE__);
    foo();
    return 0;
}

file2.h #

void foo(void);

file2.c #

#include <stdio.h>
#include "file2.h"

void foo(void) {
    printf("%s:%s:%d \n", __FILE__, __func__, __LINE__);
    return;
}

编译指令 #

gcc file1.c file2.c -o file -Wall

你当前写的这个简单示例里，就算删掉file2.c里的#include "file2.h"确实不会触发任何警告，这是因为没有声明冲突的情况下，函数定义本身就会被编译器识别为合法的声明。但大家普遍要求实现文件引入对应头文件，不是为了好看，而是为了规避复杂项目里的严重问题，核心价值有三点：

• 编译期快速捕获接口不匹配错误：如果后续你修改了头文件中foo的函数签名（比如改成int foo(int param);），但忘记同步修改file2.c里的实现，只要file2.c引入了头文件，编译阶段就会直接抛出「声明与定义不匹配」的错误。如果没有引入头文件，这个错误要到链接阶段才会被发现，甚至如果存在隐式声明兼容的情况，会直接变成很难排查的运行时错误。
• 减少重复维护成本，自动保证全局一致性：所有调用方和实现方都依赖同一份头文件的声明，只要修改一次头文件，所有不匹配的地方都会在编译期暴露，不需要手动同步修改N份函数原型。
• 明确模块归属，提升代码可读性：其他维护者看到file2.c开头引入file2.h，就能立刻明确二者是配套的接口-实现关系，不需要翻完整段代码才能判断file2.c对外暴露了哪些函数。

内容的提问来源于stack exchange，提问作者tetektoza