”工欲善其事,必先利其器。“—孔子《论语.录灵公》
首页 > 编程 > 什么是干净的代码以及为什么它很重要

什么是干净的代码以及为什么它很重要

发布于2024-07-30
浏览:170

What is Clean Code and Why it is important

只需要使用一次的代码可以随心所欲地编写。但是,在大多数情况下,遵守最佳实践和维护干净的代码至关重要。

请记住,您的代码可能会在以后被其他开发人员甚至您自己阅读。到那时,您的代码应该是不言自明的。每个变量、函数和注释都应该精确、干净且易于理解。这种方法不仅可以简化维护工作,还可以促进开发团队内部的协作和效率。

因此,当某人(或您)回来添加或修改您的代码时,将很容易理解每​​一行代码的作用。否则,您的大部分时间将花在试图理解代码上。对于在您的代码库上工作的新开发人员来说,也会出现同样的问题。如果代码不干净,他们将无法理解。因此,编写干净的代码非常重要。

什么是干净代码?

干净代码基本上是指

的代码
  1. 容易明白
  2. 易于调试
  3. 易于维护
  4. 评论写得很好,简短易懂
  5. 没有重复(冗余)代码并遵循 KISS 规则(保持简单,愚蠢!)

为了编写干净的代码,开发人员必须保持代码的一致性,并且开发人员需要遵循特定语言的最佳实践。

为什么清洁代码很重要?

当团队遵循简洁代码原则时,代码库变得更易于阅读和导航。这有助于开发人员快速理解代码并开始贡献。以下是为什么干净的代码很重要的一些原因。

1。可读性和可维护性: 当代码写得好、有良好的注释并遵循最佳实践时,很容易阅读和理解代码。一旦出现问题或错误,您就知道在哪里可以找到它。

2.调试: 干净的代码设计清晰、简单,可以更轻松地定位和理解代码库的特定部分。清晰的结构、有意义的变量名称和定义明确的函数使识别和解决问题变得更加容易。

3.提高质量和可靠性: 干净的代码遵循特定语言的最佳实践,并优先考虑结构良好的代码。它增加了质量并提高了可靠性。因此它消除了由于错误和非结构化代码而可能出现的错误。

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


干净代码的原则

要创建出色的代码,必须遵守干净代码的原则和实践,例如使用小型的、定义良好的方法。

让我们详细看看。

1。避免硬编码数字

我们可以使用常量并将该值赋给它,而不是直接使用值。因此,将来如果我们需要更新该值,我们只需在一个位置更新它。

例子

function getDate() {
  const date = new Date();
  return "Today's date: "   date;
}

function getFormattedDate() {
  const date = new Date().toLocaleString();
  return "Today's date: "   date;
}

在此代码中,在某些时候发生了变化,需要将“今天的日期:”改为“日期:”。可以通过将该字符串分配给一个变量来改进这一点。

改进代码:

const todaysDateLabel = "Today's date: ";

function getDate() {
  const date = new Date();
  return todaysDateLabel   date;
}

function getFormattedDate() {
  const date = new Date().toLocaleString();
  return todaysDateLabel   date;
}

在上面的代码中,在需要时更改日期字符串变得很容易。它提高了可维护性。

2.使用有意义且具有描述性的名称
我们可以使用更具描述性的名称,而不是到处使用通用变量名称,这是不言自明的。变量名本身应该定义它的使用。

名称规则

  1. 选择描述性且明确的名称。
  2. 进行有意义的区分。
  3. 使用可发音的名称。
  4. 使用可搜索的名称。
  5. 用命名常量替换幻数。
  6. 避免编码。不要附加前缀或类型信息。

例子

// Calculate the area of a rectangle
function calc(w, h) {
    return w * h;
}

const w = 5;
const h = 10;
const a = calc(w, h);
console.log(`Area: ${a}`);

这里的代码是正确的,但代码中有一些含糊之处。让我们看看使用描述性名称的代码。

改进的代码

// Calculate the area of a rectangle
function calculateRectangleArea(width, height) {
    return width * height;
}

const rectangleWidth = 5;
const rectangleHeight = 10;
const area = calculateRectangleArea(rectangleWidth, rectangleHeight);
console.log(`Area of the rectangle: ${area}`);

这里每个变量名称都是不言自明的。因此,很容易理解代码并提高代码质量。

3.仅在需要的地方使用注释
你不需要到处写评论。只写在需要的地方,并且写得简短易懂。太多的注释会导致混乱和混乱的代码库。

评论规则

  1. 始终尝试用代码解释自己。
  2. 不要多余。
  3. 不要添加明显的噪音。
  4. 不要使用右大括号注释。
  5. 不要注释掉代码。删除即可。
  6. 用作意图解释。
  7. 用作代码说明。
  8. 用作后果警告。

例子

// Function to get the square of a number
function square(n) {
    // Multiply the number by itself
    var result = n * n; // Calculate square
    // Return the result
    return result; // Done
}

var num = 4; // Number to square
var squared = square(num); // Call function

// Output the result
console.log(squared); // Print squared number

这里我们可以看到注释用于定义步骤,通过阅读代码很容易理解。这些注释是不必要的,并且会使代码变得混乱。让我们看看注释的正确使用。

改进的代码

/**
 * Returns the square of a number.
 * @param {number} n - The number to be squared.
 * @return {number} The square of the input number.
 */
function square(n) {
    return n * n;
}

var num = 4;
var squared = square(num); // Get the square of num

console.log(squared); // Output the result

在上面的示例中,注释仅在需要时使用。这是使代码整洁的好习惯。

4。编写只做一件事的函数
当你编写函数时,不要给它们添加太多的职责。遵循单一职责原则 (SRP)。这使得该函数更容易理解并简化了为其编写单元测试。

函数规则

  1. 保持较小。
  2. 做一件事。
  3. 使用描述性名称。
  4. 希望减少争论。
  5. 将方法拆分为多个可以从客户端调用的独立方法。

例子

async function fetchDataAndProcess(url) {
    // Fetches data from an API and processes it in the same function
    try {
        const response = await fetch(url);
        const data = await response.json();

        // Process data (e.g., filter items with value greater than 10)
        const processedData = data.filter(item => item.value > 10);

        console.log(processedData);
    } catch (error) {
        console.error('Error:', error);
    }
}

// Usage
const apiUrl = 'https://api.example.com/data';
fetchDataAndProcess(apiUrl);

在上面的示例中,我们可以看到一个使用 API 获取数据并对其进行处理的函数。这可以通过另一个函数来完成。目前,数据处理功能很小,但在生产级项目中,数据处理可能会非常复杂。那时,将其保留在同一个函数中并不是一个好的做法。这将使您的代码一次性变得复杂且难以理解。
让我们看看这个的干净版本。

改进的代码

async function fetchData(url) {
    // Fetches data from an API
    try {
        const response = await fetch(url);
        return await response.json();
    } catch (error) {
        console.error('Error:', error);
        throw error;
    }
}

function processData(data) {
    // Processes the fetched data (e.g., filter items with value greater than 10)
    return data.filter(item => item.value > 10);
}

// Usage
const apiUrl = 'https://api.example.com/data';

fetchData(apiUrl)
    .then(data => {
        const processedData = processData(data);
        console.log(processedData);
    })
    .catch(error => {
        console.error('Error:', error);
    });

在此示例中,职责是分离的:fetchData 函数处理 API 调用,processData 函数处理数据处理。这使得代码更容易理解、维护和测试。

5。避免代码重复(遵循 DRY 原则 - 不要重复自己)

为了增强代码的可维护性和整洁性,尽可能创建可重用的函数或重用现有代码。例如,如果您要从 API 获取数据以在页面上显示,您将编写一个函数来检索数据并将其传递给呈现器以进行 UI 显示。如果需要在另一页上显示相同的数据,则不应再次编写相同的函数,而应将该函数移动到实用程序文件中。这允许您在两个实例中导入和使用该函数,从而提高整个代码库的可重用性和一致性。

编写简洁代码的其他一般规则

  • 遵循标准约定(对于 JavaScript Camel Case)。
  • 保持简单愚蠢。越简单总是越好。尽可能降低复杂性。
  • 童子军规则。让露营地比你发现时更干净。
  • 始终找到根本原因。始终寻找问题的根本原因。
  • 编写易于理解的代码

从今天开始实施此实践和原则来编写干净的代码。

版本声明 本文转载于:https://dev.to/yashrajxdev/what-is-clean-code-and-why-it-is-important-2p5d?1如有侵犯,请联系[email protected]删除
最新教程 更多>
  • 如何处理PHP文件系统功能中的UTF-8文件名?
    如何处理PHP文件系统功能中的UTF-8文件名?
    在PHP的Filesystem functions中处理UTF-8 FileNames 在使用PHP的MKDIR函数中含有UTF-8字符的文件很多flusf-8字符时,您可能会在Windows Explorer中遇到comploreer grounder grounder grounder gro...
    编程 发布于2025-04-23
  • 哪种方法更有效地用于点 - 填点检测:射线跟踪或matplotlib \的路径contains_points?
    哪种方法更有效地用于点 - 填点检测:射线跟踪或matplotlib \的路径contains_points?
    在Python Matplotlib's path.contains_points FunctionMatplotlib's path.contains_points function employs a path object to represent the polygon.它...
    编程 发布于2025-04-23
  • 如何使用Regex在PHP中有效地提取括号内的文本
    如何使用Regex在PHP中有效地提取括号内的文本
    php:在括号内提取文本在处理括号内的文本时,找到最有效的解决方案是必不可少的。一种方法是利用PHP的字符串操作函数,如下所示: 作为替代 $ text ='忽略除此之外的一切(text)'; preg_match('#((。 &&& [Regex使用模式来搜索特...
    编程 发布于2025-04-23
  • 如何在Java的全屏独家模式下处理用户输入?
    如何在Java的全屏独家模式下处理用户输入?
    Handling User Input in Full Screen Exclusive Mode in JavaIntroductionWhen running a Java application in full screen exclusive mode, the usual event ha...
    编程 发布于2025-04-23
  • 反射动态实现Go接口用于RPC方法探索
    反射动态实现Go接口用于RPC方法探索
    在GO 使用反射来实现定义RPC式方法的界面。例如,考虑一个接口,例如:键入myService接口{ 登录(用户名,密码字符串)(sessionId int,错误错误) helloworld(sessionid int)(hi String,错误错误) } 替代方案而不是依靠反射...
    编程 发布于2025-04-23
  • 如何在Chrome中居中选择框文本?
    如何在Chrome中居中选择框文本?
    选择框的文本对齐:局部chrome-inly-ly-ly-lyly solument 您可能希望将文本中心集中在选择框中,以获取优化的原因或提高可访问性。但是,在CSS中的选择元素中手动添加一个文本 - 对属性可能无法正常工作。初始尝试 state)</option> < op...
    编程 发布于2025-04-23
  • Python不会对超范围子串切片报错的原因
    Python不会对超范围子串切片报错的原因
    在python中用索引切片范围:二重性和空序列索引单个元素不同,该元素会引起错误,切片在序列的边界之外没有。这种行为源于索引和切片之间的基本差异。索引一个序列,例如“示例” [3],返回一个项目。但是,切片序列(例如“示例” [3:4])返回项目的子序列。索引不存在的元素时,例如“示例” [9] ...
    编程 发布于2025-04-23
  • 如何在JavaScript对象中动态设置键?
    如何在JavaScript对象中动态设置键?
    在尝试为JavaScript对象创建动态键时,如何使用此Syntax jsObj['key' i] = 'example' 1;不工作。正确的方法采用方括号: jsobj ['key''i] ='example'1; 在JavaScript中,数组是一...
    编程 发布于2025-04-23
  • 如何实时捕获和流媒体以进行聊天机器人命令执行?
    如何实时捕获和流媒体以进行聊天机器人命令执行?
    在开发能够执行命令的chatbots的领域中,实时从命令执行实时捕获Stdout,一个常见的需求是能够检索和显示标准输出(stdout)在cath cath cant cant cant cant cant cant cant cant interfaces in Chate cant inter...
    编程 发布于2025-04-23
  • 在C#中如何高效重复字符串字符用于缩进?
    在C#中如何高效重复字符串字符用于缩进?
    在基于项目的深度下固定字符串时,重复一个字符串以进行凹痕,很方便有效地有一种有效的方法来返回字符串重复指定的次数的字符串。使用指定的次数。 constructor 这将返回字符串“ -----”。 字符串凹痕= new String(' - ',depth); console.Wr...
    编程 发布于2025-04-23
  • 如何简化PHP中的JSON解析以获取多维阵列?
    如何简化PHP中的JSON解析以获取多维阵列?
    php 试图在PHP中解析JSON数据的JSON可能具有挑战性,尤其是在处理多维数组时。 To simplify the process, it's recommended to parse the JSON as an array rather than an object.To do...
    编程 发布于2025-04-23
  • 在程序退出之前,我需要在C ++中明确删除堆的堆分配吗?
    在程序退出之前,我需要在C ++中明确删除堆的堆分配吗?
    在C中的显式删除 在C中的动态内存分配时,开发人员通常会想知道是否需要手动调用“ delete”操作员在heap-exprogal exit exit上。本文深入研究了这个主题。 在C主函数中,使用了动态分配变量(HEAP内存)的指针。当应用程序退出时,此内存是否会自动发布?通常,是。但是,即使在这...
    编程 发布于2025-04-23
  • Java中如何使用观察者模式实现自定义事件?
    Java中如何使用观察者模式实现自定义事件?
    在Java 中创建自定义事件的自定义事件在许多编程场景中都是无关紧要的,使组件能够基于特定的触发器相互通信。本文旨在解决以下内容:问题语句我们如何在Java中实现自定义事件以促进基于特定事件的对象之间的交互,定义了管理订阅者的类界面。以下代码片段演示了如何使用观察者模式创建自定义事件: args)...
    编程 发布于2025-04-23
  • 如何将PANDAS DataFrame列转换为DateTime格式并按日期过滤?
    如何将PANDAS DataFrame列转换为DateTime格式并按日期过滤?
    Transform Pandas DataFrame Column to DateTime FormatScenario:Data within a Pandas DataFrame often exists in various formats, including strings.使用时间数据时...
    编程 发布于2025-04-23
  • 为什么使用Firefox后退按钮时JavaScript执行停止?
    为什么使用Firefox后退按钮时JavaScript执行停止?
    导航历史记录问题:JavaScript使用Firefox Back Back 此行为是由浏览器缓存JavaScript资源引起的。要解决此问题并确保在后续页面访问中执行脚本,Firefox用户应设置一个空功能。 警报'); }; alert('inline Alert')...
    编程 发布于2025-04-23

免责声明: 提供的所有资源部分来自互联网,如果有侵犯您的版权或其他权益,请说明详细缘由并提供版权或权益证明然后发到邮箱:[email protected] 我们会第一时间内为您处理。

Copyright© 2022 湘ICP备2022001581号-3