2.预处理指令（#ifndef...）-CSDN博客

本文链接：https://blog.csdn.net/weixin_45535478/article/details/147403844

核心概念：

所有预处理指令都以 # 开头。
预处理在编译之前执行。
预处理器主要进行文本替换、文件包含和条件编译。

1. #include：包含文件

作用： 将指定文件的全部内容复制插入到当前指令所在的位置。最常用于包含头文件 (.h)，这些头文件通常包含函数声明、宏定义、类型定义等。
两种形式：
- #include <filename.h>：用于包含标准库头文件或系统级的头文件。预处理器会在预定义的系统路径下查找文件 (例如 <stdio.h>, <stdint.h>, <math.h>)。
- #include "filename.h"：用于包含用户自定义的头文件。预处理器通常会先在当前源文件所在的目录查找，如果找不到，再去系统路径或其他指定的包含路径下查找。
重要性：
- 模块化： 将函数声明、宏定义等放到头文件中，让代码结构更清晰。
- 代码复用： 多个源文件可以包含同一个头文件来使用相同的声明或定义。
- 接口与实现分离： 头文件定义“能做什么”（接口），源文件（.c）定义“怎么做”（实现）。
相关技巧 - 头文件保护 (Header Guards)： 为了防止同一个头文件被意外地包含多次（这会导致重复定义错误），通常使用条件编译指令来保护头文件内容，后面会讲到。

2. #define：定义宏

作用： 定义一个“宏”，可以是一个常量符号，也可以是一个带参数的“宏函数”。预处理器会在编译前进行简单的文本替换。
两种形式：
- 对象式宏 (Object-like Macro)： 定义符号常量。 C
```
#define PI 3.14159
#define BUFFER_SIZE 1024
#define DEVICE_ID "SENSOR_01"

float circumference = 2 * PI * radius;
char buffer[BUFFER_SIZE];
printf("Device: %s\n", DEVICE_ID);
```
  预处理器会把代码中出现的 PI 替换为 3.14159，BUFFER_SIZE 替换为 1024 等等。
  - 优点： 提高可读性（用有意义的名字代替“魔法数字”），方便修改（只需修改 #define 处）。
  - 缺点： 只是简单的文本替换，没有类型检查。可能不如 const 变量安全（const 有类型，作用域更明确）。
- 函数式宏 (Function-like Macro)： 定义带参数的宏，看起来像函数调用。 C
```
#define MAX(a, b) ((a) > (b) ? (a) : (b))
#define IS_ODD(n) ((n) % 2 != 0)

int largest = MAX(x, y);
if (IS_ODD(value)) { ... }
```
  预处理器会把 MAX(x, y) 替换为 ((x) > (y) ? (x) : (y))。
  - 优点： 对于非常简单的操作，可以避免函数调用的开销，提高一点点效率。可以实现一定程度的“泛型”（不关心具体类型）。
  - 重要注意事项 (易错点！)：
    1. 参数括号： 宏定义中每个参数外部最好都加上括号，例如 (a)，(b)。
    2. 整体括号： 整个宏定义的表达式外部最好也加上括号，例如 ((a) > (b) ? (a) : (b))。这可以防止因为运算符优先级问题导致的意外结果。
      - 错误示例： #define SQUARE(x) x*x。如果调用 SQUARE(a + b) 会被替换成 a + b*a + b，而不是 (a + b)*(a + b)。正确写法：#define SQUARE(x) ((x)*(x))。
    3. 副作用： 如果参数带有副作用（如 ++, --），可能会被执行多次。例如 MAX(i++, j++)，i++ 或 j++ 可能会执行两次。
    4. 无类型检查： 宏参数没有类型检查。
#undef： 用于取消一个已经定义的宏。#undef MACRO_NAME。

3. 条件编译指令 (#if, #ifdef, #ifndef, #else, #elif, #endif)

作用： 告诉预处理器根据编译时的条件，选择性地包含或排除某些代码块。最终只有满足条件的代码块会被交给编译器。
常用指令：
- #ifdef MACRO_NAME：如果 MACRO_NAME 这个宏已经被定义了 (通过 #define)，则编译后续代码块，直到遇到 #else, #elif 或 #endif。
- #ifndef MACRO_NAME：如果 MACRO_NAME 这个宏没有被定义，则编译后续代码块。
- #if constant_expression：如果后面的常量表达式（在预处理阶段求值）为真（非零），则编译后续代码块。表达式可以包含整数常量、#define 定义的常量、算术运算、位运算、逻辑运算以及 defined(MACRO_NAME) 操作符（defined 用来检查宏是否已定义）。
- #else：如果前面的 #if, #ifdef, #ifndef, #elif 条件不满足，则编译 #else 后面的代码块。
- #elif constant_expression：“else if” 的缩写。如果前面的条件不满足，则检查这个新的常量表达式。
- #endif：必须用来结束一个 #if, #ifdef 或 #ifndef 代码块。

常见用途：

头文件保护 (Header Guards)： 防止头文件被重复包含。这是 #ifndef 最经典的用法： C

// my_driver.h
#ifndef MY_DRIVER_H // 如果 MY_DRIVER_H 还没有被定义过...
#define MY_DRIVER_H // ...就定义它

// --- 头文件的实际内容 ---
struct device_config {
    int baud_rate;
    char parity;
};
void init_device(struct device_config *config);
// --- 头文件内容结束 ---

#endif // MY_DRIVER_H // 结束 #ifndef 块

当第一次包含此文件时，MY_DRIVER_H 未定义，于是 #define 和文件内容被处理。如果再次包含，MY_DRIVER_H 已经定义，#ifndef 条件为假，整个文件内容被跳过。

平台/硬件适配： 为不同的目标平台编译不同的代码。 C

#ifdef STM32F4_SERIES
    // STM32F4 特有的初始化代码
    uart_init_stm32f4();
#elif defined(ESP32_PLATFORM)
    // ESP32 特有的初始化代码
    uart_init_esp32();
#else
    #error "Unsupported hardware platform!" // 如果都不支持，编译时报错
#endif

调试代码开关： 只在调试版本中包含打印信息或其他调试辅助代码。 C

#ifdef DEBUG_MODE
    printf("Debug: Variable x = %d\n", x);
#endif
// 在编译时可以通过编译器选项定义 DEBUG_MODE (例如 gcc -DDEBUG_MODE main.c)

功能开关： 根据需要启用或禁用某些功能模块。 C

#define USE_ADVANCED_FEATURE 1 // 或者 0

#if USE_ADVANCED_FEATURE
    // 包含高级功能的代码
    setup_advanced_feature();
#endif

注释掉大块代码： 临时屏蔽一段代码。 C

#if 0 // 条件为 0 (假)，所以内部代码不会被编译
... 大段暂时不用的代码 ...
#endif

4. 其他常用指令 (了解)

#error message：让预处理器输出一个错误信息 message 并停止编译。常用于条件编译中，当配置无效或不支持时报错。
#warning message：让预处理器输出一个警告信息 message，但不停止编译。用于提示潜在问题。
#pragma directive：提供了一种向编译器传递特定于编译器的指令或信息的方法。例如：
- #pragma once：许多现代编译器支持这个指令作为头文件保护的一种替代方案，效果与 #ifndef/#define/#endif 类似，但更简洁（不过不是所有编译器都支持）。
- 其他 #pragma 可能用于控制优化级别、内存对齐、中断处理等，具体取决于编译器。