注释和代码可读性简介

注释用于解释代码并提高代码的可读性。Python 解释器会忽略注释，它们不会影响程序的执行。

在本课中，您将学习如何使用注释，以及如何编写整洁、易读的代码。

单行注释

单行注释以 # 开头。该行中 # 后面的所有内容都会被 Python 忽略。例如：

# This is a single-line comment
print("Hello, World!")

多行注释

可以使用三引号（''' 或 """）编写多行注释。例如：

"""
This is a multi-line comment.
It spans multiple lines.
"""
print("Hello, World!")

为什么使用注释？

注释有助于：

• 解释复杂的代码。
• 让其他人和未来的自己更容易理解代码。
• 调试和排查问题。

请记住，注释是写给人看的，而不是给机器看的！

良好的注释实践

以下是编写良好注释的一些建议：

• 让注释简洁且有意义。
• 避免为 x = x + 1 添加类似 # Increment x by 1 这样的显而易见的注释。
• 使用注释解释代码为何以某种方式编写。

提高代码可读性

可读的代码更容易维护和调试。以下是一些建议：

• 使用有意义的变量名和函数名。
• 保持代码行简短。
• 使用注释将代码组织成不同部分。

注释掉代码

您可以使用注释暂时禁用代码，以便进行调试。例如：

# print("This line is commented out and won’t run.")
print("This line will run.")

示例：为函数编写文档

您可以使用注释记录函数并解释其用途：

def greet(name):
    # This function greets the user by their name.
    print("Hello,", name)

greet("Alice")

我们学到了什么

在本课中，您学到了：

• 如何在 Python 中编写单行注释和多行注释。
• 注释对于代码可读性和可维护性的重要性。
• 编写注释和提高代码可读性的最佳实践。

做得很好！让我们进入下一个主题。