理解干净的代码：格式化⚡️

在软件开发中，代码不仅是为机器服务的，也是为人类服务的。

正确的代码格式对于可读性和可维护性至关重要。

《清洁代码》第 5 章讨论了这些原则，重点关注专业代码格式化的重要性。

？为什么格式很重要

正确的格式不仅仅关乎美观；还关乎美观。这是关于清晰度的。格式正确的代码：

• 提高可读性：其他开发人员（或未来的你）可以快速掌握代码的功能。

• 增强可维护性：格式清晰的代码更容易更新、重构和调试。

• 促进一致性：一致的代码是可预测的，减少任何阅读它的人的认知负担。

？代码格式化的关键原则

？ 1. 纵向开放：将相关代码分组在一起

垂直开放性是指使用空行来分隔不同的代码块，以便更容易区分不同的部分。

示例：

function processOrder(order) {
    // Validate the order
    if (!validateOrder(order)) {
        throw new Error("Invalid order");
    }

    // Process payment
    const paymentResult = processPayment(order);

    // Update inventory
    updateInventory(order);

    // Notify customer
    notifyCustomer(order);
}

在此示例中，processOrder 函数中的每个步骤均由空行分隔，清楚地描绘了流程的不同阶段。

？ 2. 横向开放：调整代码以保持清晰

水平开放性涉及水平对齐代码以使其更具可读性，特别是在处理类似或相关的语句时。

示例：

const productName  = "Laptop";
const productPrice = 999.99;
const productStock = 50;

以这种方式对齐变量声明可以更容易地一目了然地看到每个变量代表的含义。

？ 3. 缩进：按层次结构构建代码

缩进是反映代码层次结构的关键。它可以帮助读者快速识别属于在一起的代码块，例如循环、条件和函数。

示例：

function calculateDiscount(price) {
    if (price > 100) {
        return price * 0.1;
    } else {
        return 0;
    }
}

这里，if-else结构是缩进的，以表明返回语句是条件逻辑的一部分。

？ 4. 线路长度：保持易于管理

长行代码可能难以阅读和理解。一般规则是将行长度控制在 80-100 个字符以内。如果一行太长，请考虑将其分解。

示例：

// Instead of this:
const orderSummary = `Order for ${customer.name}, Total: $${order.total}, Items: ${order.items.length}`;

// Do this:
const orderSummary = `Order for ${customer.name}, 
    Total: $${order.total}, 
    Items: ${order.items.length}`;

将字符串分成多行使其更具可读性，特别是当字符串包含多个变量时。

？ 5. 一致的支撑：减少混乱

支撑风格是一致性至关重要的另一个领域。两种常见的样式是：

• K&R 风格： 左大括号与语句在同一行。
• Allman 风格： 在新行上打开大括号。

K&R 风格示例：

function add(a, b) {
    return a + b;
}

奥尔曼风格示例：

function add(a, b) 
{
    return a + b;
}

选择一种风格并在整个代码库中坚持使用它。一致性比具体风格更重要。

？ 6. 避免密集代码：留出喘息的空间

密集的代码，太多的操作被塞进一个很小的空间，可能很难阅读。展开您的代码，使其更易于理解。

示例：

// Dense code
if (user.isLoggedIn) { user.showDashboard(); }

// Better
if (user.isLoggedIn) {
    user.showDashboard();
}

第二个版本更具可读性，因为函数调用与条件位于单独的行上。

结论✅

格式化对于代码的可读性和可维护性很重要。

遵循干净代码中的原则，您可以使您的 JavaScript 代码更专业、更易于理解和使用。

快乐编码！

以上是理解干净的代码：格式化⚡️的详细内容。更多信息请关注PHP中文网其他相关文章！