python-函数的文档说明

Posted 2020-12-14 忆梦，惊梦

01- 可以在时间过了很久后 快速读懂自己的代码
02- 便于工作的交接

# 函数
def my_func(a, b):
    # 文档说明
    """

    :param a:
    :param b:
    :return:
    """
    # 单行注释
    num = 10
    return a + b + num

# 假设 len函数
# 函数的文档说明 -> 加的文档说明 是python
# help(len)
# len python内置函数 python创建

# 很多的时候需要程序员自己创建
# 自定义一个函数
def add2num(num1, num2):
    return num1 + num2
help(add2num)  # 如果一个自定义函数 没有文档说明 默认是用help会打印函数上面的注释

# 自定义一个函数
def add2num(num1, num2):
    """
    这个函数是用来计算两个数的和的
    :param num1: 数字1
    :param num2: 数字2
    :return: 返回值是两个数字相加
    """
    return num1 + num2
help(add2num)
# 一切靠自觉
# add2num([1, 2], (1, 3))  # 错误的

完