Python 注释

在编写 Python 代码时，注释是一种非常有用的工具。注释是一些被程序忽略的文本，它们被用来解释代码并提高代码的可读性。Python 注释是一种强大的方式，能够帮助程序员组织和理解代码。

单行注释

Python 中的单行注释以 # 开头，在该符号之后的所有文本都会被忽略。单行注释通常用于解释代码的某个特定部分。

# 这是一个示例的单行注释
a = 5 # 该行代码赋值给变量 a，这是一个单行注释

多行注释

多行注释在 Python 中同样非常有用，主要用于文档字符串和长注释。多行注释以三个单引号或双引号开头和结尾。其中文档字符串通常被用来描述模块、类或函数的作用，它们集成在代码中并通过字符串进行访问。

"""
这是一个示例的多行注释。
可以在这里编写文档字符串或长注释。
"""

def add(a, b):
    """
    这是一个文档字符串，描述了函数的作用。
    这个函数将两个数相加并返回它们的和。
    """
    return a + b

多行注释也可以用于提高代码的可读性，特别是当代码需要详细的解释时。

"""
这是用于计算圆面积的函数。
输入参数:
    * radius: 圆的半径
    
输出结果:
    圆的面积，单位为平方米。
"""
def compute_area(radius):
    return 3.14 * radius ** 2

总结

Python 注释是编写高质量代码的一个重要部分。它们可以用于解释代码、提高代码的可读性、和编写文档字符串。通过使用单行注释和多行注释，程序员可以更好地组织代码并提高代码的可维护性。