Python 3 中的注释

无论您是正在学习 Python 还是正在写一些大型程序，您很快就会发现代码需要注释来阐明其目的。注释是 Python 编程中不可或缺的一部分。

单行注释

Python 中的单行注释以 # 开头。任何位于 # 后面的文本都会被 Python 解释器忽略。单行注释通常在同一行上给出有关代码的解释或说明。

# 这是一个单行注释
print("Hello World!")

多行注释

Python 中的多行注释也称为块注释，它是指由三个引号 """ 或 ''' 包围的字符串。多行注释通常用来提供有关模块、函数或类的文档。

"""
这是一个多行注释
用来提供有关模块、函数或类的文档。
"""
print("Hello World!")

文档字符串

文档字符串是 Python 编程中的一种注释形式，用于描述模块、函数或类的用途、参数、返回值等信息。文档字符串通常出现在函数或方法的第一行，并由三个引号 """ 或 ''' 包围。

def add(a, b):
    """
    这是一个加法函数，用于计算两个数的和。
    参数：
        a (int)：第一个整数
        b (int)：第二个整数
    返回值：
        int：两个数的和
    """
    return a + b

Python 代码注释的最佳实践

• 注释应该用于阐述代码的处境、原因和目标。

• 注释应该简洁、明了且易于理解。

• 注释不应该重复代码的内容，而应该增加有用的信息。

• 有多行注释时，将每一行限制在 72 个字符以内。

• 为每个类和函数编写文档字符串，以便于自动生成文档和提供有关函数或类的信息。

• 根据项目或团队的规定编写一致的注释风格。