什么是干净代码？

开发者们大家好，
当开发人员谈论“干净的代码”时，他们通常指的是易于阅读、理解和维护的代码。干净的代码不仅仅是让你的代码看起来漂亮，而是让你的团队中的任何人都可以拿起、理解和修改代码，而不必费力地阅读无休止的注释或令人困惑的逻辑。编写干净的代码需要技巧和采用重视简单、清晰和目的的心态。

在这篇文章中，我们将探讨干净代码的主要原则、其重要性，并提供 python 示例来展示如何在实践中应用这些想法。

为什么干净的代码很重要

可读性：代码的阅读次数多于编写次数。干净的代码确保其他人（以及将来的您）可以快速阅读和理解它。
可维护性：干净的代码更容易修改、修复和扩展，而不会引入错误。
可扩展性：干净、模块化的代码更容易扩展并适应新的需求。
减少技术债务：凌乱的代码可能会导致错误，并且每次修复都会带来更多的复杂性。干净的代码通过保持简单性来避免这种螺旋式上升。

好处是显而易见的，但实现干净的代码是一门学科。让我们看看基本原理。

整洁代码的关键原则

1. 有意义的名字

名称应该传达意图。变量、函数和类名称应清楚地描述其用途。

示例：

# bad
def cal(x, y):
    return x * y

# good
def calculate_area(width, height):
    return width * height

在“坏”示例中，不清楚 cal、x 和 y 代表什么。在“好”示例中，calculate_area、宽度和高度传达了目的并使代码不言自明。

2. 单一职责原则（srp）

每个函数或类应该有一个单一的职责或目的。这降低了复杂性并使代码更易于理解和维护。

示例：

# bad
class order:
    def calculate_total(self, items):
        # logic for calculating total
        pass

    def send_order_confirmation_email(self):
        # logic for sending an email
        pass

# good
class order:
    def calculate_total(self, items):
        # logic for calculating total
        pass

class orderconfirmationemail:
    def send(self):
        # logic for sending an email
        pass

在“好的”示例中，order 和 orderconfirmationemail 负责应用程序的不同方面，遵循 srp。

3. 避免使用幻数和字符串

对任何“神奇”数字或字符串使用常量或变量，使您的代码更清晰且更易于修改。

示例：

# bad
if user_age > 18:
    # perform some action for adults

# good
minimum_age = 18
if user_age > minimum_age:
    # perform some action for adults

4. 保持职能小而集中

函数应该做一件事并且把它做好。避免使用很长或执行多项任务的函数。

示例：

# bad
def process_order(order):
    # validate order
    # calculate total
    # send confirmation email
    pass

# good
def validate_order(order):
    pass

def calculate_order_total(order):
    pass

def send_order_confirmation(order):
    pass

“好”示例中的每个函数都执行一项特定任务，使代码更加模块化和可重用。

5. 明智地使用评论

评论应该解释“为什么”，而不是“什么”。理想情况下，代码应该是不言自明的；谨慎使用注释，仅在必要时提供上下文。

示例：

# bad
def multiply(a, b):
    # multiply a by b
    return a * b

# good
def calculate_discounted_price(price, discount):
    # apply discount to the original price
    return price * (1 - discount)

在“bad”示例中，注释是多余的。在“好”示例中，评论提供了额外的上下文，解释了我们应用折扣的原因。

6. 一致的格式

一致的格式，例如缩进和换行符，可以提高可读性。遵循 pep 8 for python 等标准风格指南，或定义团队的编码约定。

示例：

# bad
def foo():print("foo")

# good
def foo():
    print("foo")

7. 错误处理

优雅地处理错误。代码应该预见潜在的错误，并提供清晰的错误消息和恢复选项。

示例：

# Bad
def open_file(filename):
    file = open(filename, 'r')
    content = file.read()
    file.close()
    return content

# Good
def open_file(filename):
    try:
        with open(filename, 'r') as file:
            return file.read()
    except IOError:
        print("An error occurred while opening the file.")

“好”示例确保错误得到处理，并且资源正确关闭。

干净代码背后的心态

干净的代码需要一种优先考虑简单性、清晰性的心态，并且对将阅读和维护代码的其他开发人员具有同理心。这种心态重视保持代码简洁但信息丰富的实践，减少不必要的复杂性并使代码库更可靠且使用起来更愉快。

总结

编写干净的代码是一个持续的学习过程，需要努力和纪律。请记住：

清楚地命名事物。
保持函数较小。
遵循单一职责原则。
优雅地处理错误。

干净的代码可能看起来需要额外的努力，但在可维护性、协作和面向未来的工作方面的回报是无价的。遵循这些原则，您将能够构建出不仅可以运行而且使用起来充满乐趣的软件。

让我们保持代码整洁和项目可扩展！

以上就是什么是干净代码？的详细内容，更多请关注其它相关文章！