Python中的多行注释

Python中的多行注释是一种注释代码的方式，通常用于给函数或者类定义添加文档注释。在Python中，多行注释使用三个引号（''' 或 """）来标识。

语法

使用三个引号来标识一段多行注释代码：

'''
这里是多行注释的内容
'''

或者使用另一种三个引号：

"""
这里是多行注释的内容
"""

用途

多行注释通常用于给函数或类定义添加文档注释。在文档注释中，会使用特定的语法来描述函数或类的功能、参数、返回值等信息。以下是一个示例：

def add_num(num1, num2):
    """
    计算两个数字之和。
    
    :param num1: 第一个数字
    :type num1: int
    :param num2: 第二个数字
    :type num2: int
    :return: 两个数字之和
    :rtype: int
    """
    return num1 + num2

在上面的示例中，我们使用文档注释来描述了函数的功能、参数和返回值。使用多行注释可以使得文档注释更加清晰、易读。

注意事项

• 多行注释中的内容不会被执行，仅作为注释使用。
• 在多行注释中也可以使用单行注释（以 # 开头），但是不推荐这么做。
• 在文档注释中可以使用一些特定的语法，比如 :param 用于描述函数参数，:return 用于描述返回值，详情请参考官方文档。

总结

Python中的多行注释是一种方便的注释代码的方式，通常用于给函数或者类定义添加文档注释。使用多行注释可以使得代码更加清晰、易读。