编写干净的代码：最佳实践和原则

2025-05-24

编写干净的代码：最佳实践和原则

介绍

编写简洁的代码是每位软件开发者的一项基本技能。简洁的代码不仅能让你的代码库更易于维护和理解，还能促进团队成员之间的协作。在这篇内容丰富的文章中，我们将探讨什么是简洁的代码，它为何重要，并提供一系列最佳实践和原则，帮助你编写简洁且可维护的代码。

什么是干净代码？

整洁代码是指易于阅读、理解和修改的代码。它避免了不必要的复杂性、冗余和混乱。整洁代码遵循一系列约定和最佳实践，使其更加一致，从而方便多个开发人员无缝协作于同一项目。

为什么清洁代码很重要？

  1. 可读性：简洁的代码易于阅读，这意味着任何人（包括未来的你自己）都能快速理解。这减少了掌握代码功能所需的时间，从而加快了开发和调试的速度。

  2. 可维护性：代码的阅读频率远高于编写频率。编写简洁的代码，随着时间的推移，维护和扩展应用程序会变得更加容易。这在软件开发生命周期中至关重要，因为项目通常会不断发展和壮大。

  3. 协作：简洁的代码有利于协作。当你的代码简洁且井然有序时，其他团队成员就能高效地处理它。这使得任务划分和同时处理代码库的不同部分变得更加容易。

  4. 减少错误：干净的代码可以降低引入错误的可能性。难以理解的代码在修改或增强过程中更容易出错。

  5. 效率：简洁的代码是高效的代码。它通常运行速度更快，占用的资源更少，因为它避免了不必要的操作和复杂性。

现在我们了解了为什么干净的代码很重要，让我们深入研究一些最佳实践和原则来帮助您编写干净的代码。

编写干净代码的最佳实践和原则

1.有意义的变量和函数名称

为变量、函数、类和其他标识符使用描述性名称。精心挑选的名称可以传达实体的用途，使代码更易于理解。避免使用单字母变量名或晦涩难懂的缩写。

# Bad variable name
x = 5

# Good variable name
total_score = 5
Enter fullscreen mode Exit fullscreen mode

2.保持函数和方法简短

函数和方法应该简洁，并专注于单一任务。单一职责原则 (SRP) 指出，一个函数应该只做一件事，并且要做好。较短的函数更易于理解、测试和维护。如果一个函数过长或复杂，可以考虑将其分解为更小、更易于管理的函数。

// Long and complex function
function processUserData(user) {
    // Many lines of code...
}

// Refactored into smaller functions
function validateUserInput(userInput) {
    // Validation logic...
}

function saveUserToDatabase(user) {
    // Database operation...
}
Enter fullscreen mode Exit fullscreen mode

3.评论和文档

谨慎使用注释，如果使用，务必使其有意义。代码应尽可能清晰易懂。文档（例如内联注释和 README 文件）有助于其他开发者理解代码的目的和用法。请记录复杂的算法、重要的决策和公共 API。

# Bad comment
x = x + 1  # Increment x

# Good comment
# Calculate the total score by incrementing x
total_score = x + 1
Enter fullscreen mode Exit fullscreen mode

4.一致的格式和缩进

坚持一致的代码风格和缩进。这能让代码库看起来干净整洁。大多数编程语言都有社区认可的编码标准（例如，Python 的 PEP 8，JavaScript 的 eslint），你应该遵循这些标准。一致性也适用于命名约定、间距和代码结构。

// Inconsistent formatting
if(condition){
    doSomething();
  } else {
      doSomethingElse();
}

// Consistent formatting
if (condition) {
    doSomething();
} else {
    doSomethingElse();
}
Enter fullscreen mode Exit fullscreen mode

5. DRY（不要重复自己）原则

避免重复代码。重复的代码更难维护，并且会增加不一致的风险。将通用功能提取到函数、方法或类中，以提高代码的可重用性。当您需要进行更改时，只需在一个地方进行即可。

假设您正在开发一个 JavaScript 应用程序，用于计算购物车中商品的总价。最初，您有两个单独的函数用于计算每种商品类型的价格：一个用于计算书籍的价格，另一个用于计算笔记本电脑的价格。以下是初始代码：

function calculateBookPrice(quantity, price) {
    return quantity * price;
}

function calculateLaptopPrice(quantity, price) {
    return quantity * price;
}
Enter fullscreen mode Exit fullscreen mode

虽然这些函数可以正常工作，但它们违反了 DRY 原则，因为计算不同商品类型的总价的逻辑是重复的。如果您要计算的商品类型更多，最终将重复此逻辑。为了遵循 DRY 原则并提高代码的可维护性，您可以按如下方式重构代码：

function calculateItemPrice(quantity, price) {
    return quantity * price;
}

const bookQuantity = 3;
const bookPrice = 25;

const laptopQuantity = 2;
const laptopPrice = 800;

const bookTotalPrice = calculateItemPrice(bookQuantity, bookPrice);
const laptopTotalPrice = calculateItemPrice(laptopQuantity, laptopPrice);
Enter fullscreen mode Exit fullscreen mode

在重构后的代码中，我们只有一个calculateItemPrice函数，该函数根据传入的参数数量和价格计算任意商品类型的总价。这符合DRY原则，因为计算逻辑不再重复。

现在，您可以通过调用calculateItemPrice函数并传入相应的数量和价格值，轻松计算书籍、笔记本电脑或任何其他商品类型的总价。这种方法提高了代码的可重用性、可读性和可维护性，同时降低了代码重复导致错误的风险。

6.使用有意义的空白

使用空格和换行符正确格式化代码。这可以提高可读性。使用空格分隔代码的逻辑部分。格式良好的代码更易于扫描，从而减轻读者的认知负担。

// Poor use of whitespace
const sum=function(a,b){return a+b;}

// Improved use of whitespace
const sum = function (a, b) {
    return a + b;
}
Enter fullscreen mode Exit fullscreen mode

7.错误处理

优雅地处理错误。在代码中使用适当的 try-catch 块或错误处理机制。这可以防止意外崩溃，并为调试提供有价值的信息。不要隐藏错误或简单地记录错误而没有适当的响应。

// Inadequate error handling
try {
    result = divide(x, y);
} catch (error) {
    console.error("An error occurred");
}

// Proper error handling
try {
    result = divide(x, y);
} catch (error) {
    if (error instanceof ZeroDivisionError) {
        console.error("Division by zero error:", error.message);
    } else if (error instanceof ValueError) {
        console.error("Invalid input:", error.message);
    } else {
        console.error("An unexpected error occurred:", error.message);
    }
}
Enter fullscreen mode Exit fullscreen mode

8.测试

编写单元测试来验证代码的正确性。测试驱动开发 (TDD) 可以强制你预先考虑极端情况和预期行为，从而帮助你编写更简洁的代码。经过充分测试的代码更可靠，也更易于重构。

// Example using JavaScript and the Jest testing framework
test('addition works correctly', () => {
    expect(add(2, 3)).toBe(5);
    expect(add(-1, 1)).toBe(0);
    expect(add(0, 0)).toBe(0);
});
Enter fullscreen mode Exit fullscreen mode

9.重构

定期重构代码。随着需求的变化以及对问题域理解的加深，请相应地调整代码。重构有助于在项目发展过程中保持代码的简洁。必要时，不要害怕重新审视和改进现有代码。

假设您有一个函数，可以计算购物车中商品的总价，并具有固定的折扣百分比：

function calculateTotalPrice(cartItems) {
    let totalPrice = 0;
    for (const item of cartItems) {
        totalPrice += item.price;
    }
    return totalPrice - (totalPrice * 0.1); // Apply a 10% discount
}
Enter fullscreen mode Exit fullscreen mode

最初，此函数计算总价并应用 10% 的固定折扣。然而，随着项目的发展，您意识到需要支持可变折扣。为了重构代码以使其更加灵活，您可以引入一个 discount 参数：

function calculateTotalPrice(cartItems, discountPercentage) {
    if (discountPercentage < 0 || discountPercentage > 100) {
        throw new Error("Discount percentage must be between 0 and 100.");
    }

    let totalPrice = 0;
    for (const item of cartItems) {
        totalPrice += item.price;
    }

    const discountAmount = (totalPrice * discountPercentage) / 100;
    return totalPrice - discountAmount;
}
Enter fullscreen mode Exit fullscreen mode

在此重构代码中：

  • 我们在calculateTotalPrice函数中添加了discountPercentage参数，允许您在调用该函数时指定折扣百分比。

  • 我们对 discountPercentage 参数进行验证，确保其在有效范围内（0 到 100%）。如果超出范围，则会抛出错误。

  • 折扣计算现在基于提供的 discountPercentage，使功能更加灵活并适应不断变化的需求。

通过这种方式重构代码，您提高了代码的灵活性和可维护性。您可以轻松调整函数以处理不同的折扣场景，而无需重写整个逻辑。这体现了随着项目发展和需求变化，定期进行代码重构的重要性。

10.版本控制

使用 Git 等版本控制系统来跟踪代码更改。这使您能够与团队成员有效协作，在必要时恢复到之前的版本，并维护项目开发的完整历史记录。Git 提供了代码审查、分支和合并工具，促进协作并保持代码整洁。

结论

编写简洁的代码不仅仅是一套规则，更是一种思维方式和一门学科。它关乎创建易于阅读、维护和扩展的软件。遵循这些最佳实践和原则，您可以成为更熟练的开发人员，编写高质量的代码。花时间仔细研究其他工程师的代码库，尤其是在开源项目中，可以带来启发。通过这种探索，您可以获得对各种编码风格和策略的宝贵见解。这种体验使您能够提炼出编写简洁、可持续代码库的精髓。请记住，编写简洁的代码是一个持续的过程，通过不断练习，它会成为您的第二天性，从而带来更高效、更愉悦的软件开发体验。

文章来源：https://dev.to/favourmark05/writing-clean-code-best-practices-and-principles-3amh
Devto 翻译
PREV
真正有用的 Nocode 工具列表，我并不是在谈论网站构建器。
NEXT
你应该有自己的域名