Python中的注释和文档

下面就Python中的注释做一些演示：单号注释，多行注释，文档注释

1. 单行注释

# This is a single line comment in Python

使用# 号，后面的字符串是单行注释内容

2.多行注释

使用三单引号或三双引号

"""

This type of comment spans multiple lines.

These are mostly used for documentation of functions, classes and modules.

""

3. 文档注释

文档字符串 - 与常规注释不同 - 存储为它们记录的函数的属性，这意味着你可以以编程方式访问它们。

例如，先声明一个函数，添加文档注释

def Add(x, y):

"""

    计算2个输入数的和

    :param x:第一个加数

    :param y:第二个加数

    :return:返回和值"""

    return x+y

使用函数的__doc__属性获取文档注释

print(Add.__doc__)

输出：

    计算2个输入数的和

    :param x:第一个加数

    :param y:第二个加数

    :return:返回和值