C 的代码风格和规范-CSDN博客

C 代码风格和规范

C 代码风格和规范是提高代码可读性、可维护性和团队协作效率的关键。良好的风格能减少错误，并让代码更易于理解。以下基于业界广泛接受的指南（如Google C Style Guide、LLVM规范等）进行总结。我将从核心原则入手，逐步解释常见规范，并提供示例代码。建议在实际开发中保持一致，并参考官方文档。

1. 核心原则

一致性：团队内所有成员遵循同一套规则。
可读性优先：代码应像自然语言一样易读，避免过度优化导致晦涩。
安全性：优先使用现代C 特性（如智能指针、RAII）来避免内存泄漏和未定义行为。

2. 主要规范

命名约定：
- 变量和函数：使用小写蛇形命名（snake_case），例如：int student_count; 或 void calculate_average();。
- 类和结构体：使用首字母大写的驼峰命名（PascalCase），例如：class StudentRecord;。
- 常量：使用全大写蛇形命名，例如：const int MAX_SIZE = 100;。
- 命名空间：使用小写蛇形命名，例如：namespace my_project;。
- 避免缩写：除非广泛认可（如idx for index），否则使用完整单词。
缩进和空格：
- 缩进：使用4个空格（而非制表符），每个块级结构（如if、for）缩进一级。
- 空格规则：
  - 操作符周围添加空格，例如：int sum = a b;。
  - 逗号后添加空格，例如：void func(int a, int b);。
  - 控制语句后加空格，例如：if (condition) { ... }。
- 行长度：建议不超过80个字符，便于阅读。
注释风格：
- 行内注释：使用//，解释复杂逻辑或意图，而非重复代码。例如：// 检查边界条件，避免越界。
- 块注释：使用/* ... */，用于文件头或函数描述。
- 文档注释：对公共API使用Doxygen风格，例如：/// 计算两个数的和。
代码组织：
- 文件结构：头文件（.h或.hpp）放声明，源文件（.cpp）放定义。使用#pragma once或#ifndef防止重复包含。
- 包含顺序：先标准库，再第三方库，最后项目文件。例如：
```
#include <vector>
#include my_header.h\n       ```
```
- 函数设计：函数应短小（建议不超过50行），单一职责。参数传递：输入用const&，输出用指针或引用。
其他最佳实践：
- 避免全局变量：使用局部变量或封装在类中。
- 使用const：修饰不应修改的变量或参数，例如：const std::string& name。
- 异常处理：谨慎使用异常，优先返回错误码或std::optional。
- 现代C 特性：优先用auto、nullptr、范围for循环（如for (auto& item : list)），避免裸指针。

3. 示例代码

以下是一个简单示例，展示规范的应用：计算阶乘的函数，包括命名、缩进、注释和错误处理。

// 示例：计算非负整数的阶乘
#include <stdexcept>  // 包含标准异常库

/// @brief 计算阶乘值
/// @param n 输入的非负整数
/// @return 阶乘结果
/// @throws std::invalid_argument 如果n为负数
int factorial(int n) {
    // 检查输入有效性
    if (n < 0) {
        throw std::invalid_argument(为非负数\n    }

    int result = 1;  // 初始化结果变量
    for (int i = 1; i <= n;   i) {
        result *= i;  // 累乘计算
    }
    return result;
}