C语言命名规范

C语言命名规范是提高代码可读性、可维护性和一致性的重要基础。以下是常见的C语言命名规范及其适用场景，结合示例说明：

一、基本原则

1. 可读性优先

   • 使用有意义的单词或缩写，避免无意义的单字母命名（如 a, x 除非是临时变量或循环计数器）。
   • 示例：

     // 不推荐
     int a = calculate_area(5, 10);
     
     // 推荐
     int rectangle_area = calculate_rectangle_area(width, height);
     

2. 避免歧义

   • 不使用易混淆的单词（如 l 与 1, O 与 0）。
   • 示例：

     // 不推荐：变量名易与数字混淆
     int l = 10;  // 字母 l 与数字 1
     
     // 推荐
     int length = 10;
     

3. 一致性

   • 项目内统一命名风格（如驼峰命名法或蛇形命名法）。
   • 示例：

     // 统一使用蛇形命名法（snake_case）
     int max_value = get_max_value();
     void initialize_system(void);
     
     // 或统一使用大驼峰命名法（PascalCase）
     int MaxValue = GetMaxValue();
     void InitializeSystem(void);
     

二、变量命名规范

1. 普通变量

• 风格：蛇形命名法（小写字母 + 下划线）。
• 示例：

  int current_temp;
  float average_speed;
  char* error_message;
  

2. 全局变量

• 风格：蛇形命名法 + 前缀（如 g_ 或模块名），增强作用域辨识度。
• 示例：

  // 模块内全局变量
  static int g_system_status;  // 静态全局变量（文件内可见）
  
  // 跨模块全局变量（需在头文件声明）
  extern int app_config_mode;  // 前缀暗示外部可见
  

3. 常量/宏

• 风格：全大写 + 下划线（蛇形命名法）。
• 示例：

  #define MAX_LENGTH 100
  #define PI 3.14159
  
  // 枚举常量
  enum Status {
      STATUS_OK = 0,
      STATUS_ERROR = -1,
      STATUS_PENDING = 1
  };
  

4. 结构体/联合体成员

• 风格：与普通变量一致（蛇形命名法），嵌套结构体可加前缀。
• 示例：

  struct Point {
      int x_pos;
      int y_pos;
  };
  
  struct Rectangle {
      struct Point top_left;  // 嵌套结构体加前缀
      struct Point bottom_right;
  };
  

三、函数命名规范

1. 普通函数

• 风格：蛇形命名法，动词 + 名词结构，清晰表达功能。
• 示例：

  int calculate_sum(int a, int b);
  void initialize_device(void);
  bool is_valid_input(char* str);
  

2. 库函数/API

• 风格：蛇形命名法 + 模块前缀，避免命名冲突。
• 示例：

  // 标准库函数
  int printf(const char* format, ...);
  void* malloc(size_t size);
  
  // 自定义库（如驱动模块）
  int i2c_init(void);
  int i2c_read(uint8_t addr, uint8_t* data, size_t len);
  

3. 回调函数

• 风格：蛇形命名法 + _callback 后缀。
• 示例：

  void button_click_callback(int button_id);
  void timer_expired_callback(void* context);
  

四、类型命名规范

1. 结构体/联合体类型

• 风格：蛇形命名法 + _t 后缀（或大驼峰命名法）。
• 示例：

  // 推荐方式（带 _t 后缀）
  typedef struct {
      int width;
      int height;
  } rectangle_t;
  
  // 大驼峰命名法（常用于C++风格的C代码）
  typedef struct {
      int x;
      int y;
  } Point;
  

2. 枚举类型

• 风格：蛇形命名法 + _e 后缀（或大驼峰命名法），枚举值加类型前缀。
• 示例：

  // 带 _e 后缀
  typedef enum {
      COLOR_RED,
      COLOR_GREEN,
      COLOR_BLUE
  } color_e;
  
  // 大驼峰命名法
  typedef enum {
      StatusSuccess,
      StatusFailure,
      StatusPending
  } Status;
  

3. typedef 别名

• 风格：与结构体类似，使用 _t 后缀。
• 示例：

  typedef int (*callback_func_t)(void*);  // 函数指针类型
  typedef uint8_t byte_t;                // 基础类型别名
  

五、文件命名规范

1. C源文件（.c）和头文件（.h）

   • 风格：蛇形命名法，与模块功能匹配。
   • 示例：

     // 模块文件
     device_driver.c
     device_driver.h
     
     // 工具库文件
     string_utils.c
     string_utils.h
     

2. 特殊文件

   • 主程序文件：通常为 main.c。
   • 平台相关文件：加平台后缀（如 driver_esp32.c）。

六、特殊场景命名

1. 指针变量

• 风格：在变量名前加 p_ 前缀（可选，但增强可读性）。
• 示例：

  char* p_buffer;       // 明确表示指针
  struct Node* p_node;  // 链表节点指针
  

2. 位域/标志变量

• 风格：使用 is_、has_ 前缀或 _flag 后缀。
• 示例：

  bool is_initialized;
  uint8_t status_flags;
  #define FLAG_READY (1 << 0)
  #define FLAG_ERROR (1 << 1)
  

3. 硬件相关变量

• 风格：使用大写 + 下划线，模拟寄存器命名（如MCU固件）。
• 示例：

  #define GPIO_PORT_A 0x40004000
  #define ADC_CHANNEL_0 (1 << 0)
  

七、行业/项目常见规范

1. GNU风格

   • 全部使用蛇形命名法（如GCC源码）。
   • 示例：

     int get_file_size(const char* path);
     void free_memory(void* ptr);
     

2. 嵌入式系统（如Linux内核）

   • 蛇形命名法，强调与硬件的关联性。
   • 示例：

     int i2c_master_init(void);
     void gpio_set_pin_state(uint8_t pin, bool state);
     

3. Windows API风格

   • 大驼峰命名法（如Win32 API）。
   • 示例：

     BOOL CreateFile(const char* name, DWORD access, ...);
     HANDLE OpenProcess(DWORD access, BOOL inherit, DWORD pid);
     

八、命名规范工具

• 静态代码分析工具：
  • cppcheck、Clang-Tidy 可检查命名是否符合指定规范。
• IDE配置：
  • Visual Studio Code、CLion 等可通过插件强制命名规则（如 .editorconfig）。

总结

C语言命名规范的核心目标是提高代码可读性和一致性，常见的命名风格包括：

• 蛇形命名法（snake_case）：变量、函数、文件命名的主流选择。
• 大驼峰命名法（PascalCase）：常用于类型定义（如结构体、枚举）。
• 全大写 + 下划线：常量、宏定义的标准写法。

选择一种风格并保持一致性，避免混用不同规范，可显著提升代码质量和团队协作效率。