C++ 中的 Clean Code：编写可读代码的原则

轻松学习Python，无需理论负担。在浏览器中直接解决带自动检查的实践任务，无需安装任何东西。

C++中的Clean Code：原则与示例

在现代软件开发中，编写能运行的代码只是成功的一半。真正的技巧体现在创建易于阅读、理解和修改的代码。由Robert Martin（Uncle Bob）推广的Clean Code（整洁代码）概念适用于任何编程语言，包括C++。在本文中，我们将通过实际示例分析在C++中编写整洁代码的关键原则。

为什么Clean Code对C++很重要？

C++是一种强大但复杂的语言。它赋予开发者极大的自由，但如果不遵守纪律，这种自由可能导致混乱。C++中的脏代码可能包含未定义行为、内存泄漏和难以理解的构造。C++中的整洁代码是以下方面的保证：

减少调试时间：可读的代码更容易测试和审查。
易于维护：你的同事（或半年后的你自己）能快速理解逻辑。
减少Bug数量：清晰的代码更少包含隐藏错误。
改善团队协作：统一的代码风格加速代码审查。

原则1：有意义的命名

整洁代码的第一个也是最重要的原则是正确命名变量、函数和类。名称应该回答"为什么？"和"做什么？"的问题。

糟糕的示例：

int d; // elapsed time in days

良好的示例：

int elapsedTimeInDays;

避免缩写（除了普遍接受的，例如循环计数器的i）。对变量和函数使用camelCase，对类使用PascalCase。保持一致性。

函数的规则：

函数名称应清晰描述其功能。如果函数执行多个操作，这是将其拆分的理由。

// 糟糕void processData();

// 良好void calculateAverageScore();void validateUserInput();

原则2：函数应该短小且只做一件事

单一抽象层次原则（Single Level of Abstraction）指出：在一个函数内部，不应混合高级操作（例如"获取数据"）和低级操作（例如"打开文件并读取4个字节"）。

糟糕的示例（单体函数）：

void processOrder(Order& order) {    // 验证    if (order.items.empty()) {        throw std::runtime_error("Order is empty");    }    // 计算税费    double tax = 0.0;    for (auto& item : order.items) {        tax += item.price * 0.2;    }    // 保存到文件    std::ofstream file("orders.log", std::ios::app);    file << order.id << "," << tax << std::endl;}

良好的示例（拆分为小函数）：

void validateOrder(const Order& order) {    if (order.items.empty()) {        throw std::runtime_error("Order is empty");    }}

double calculateTax(const Order& order) {    double tax = 0.0;    for (auto& item : order.items) {        tax += item.price * 0.2;    }    return tax;}

void logOrderToFile(const Order& order, double tax) {    std::ofstream file("orders.log", std::ios::app);    file << order.id << "," << tax << std::endl;}

void processOrder(Order& order) {    validateOrder(order);    double tax = calculateTax(order);    logOrderToFile(order, tax);}

现在每个函数只做一件事，并且有清晰的名称。