文档字符串

文档字符串

  Python中我们可以定义很多函数，函数越多，对于开发人员来说，就会乱。

  有两种方法解决这个问题，

  第一种是在开发的时候为每个函数写一个文档进行说明，

  第二种是Python种所特有的特性，就是在每个函数开头的地方，加上一行说明性文字，这行说明性文字称为文档字符串。

#文档字符串

def d(i,j):
    '''
    这个函数实现一个乘法运算。
    :param i:
    :param j:
    :return:
    '''
    k=i*j
    return k

print  d.__doc__
help(d)

输出:

    这个函数实现一个乘法运算。
    :param i:
    :param j:
    :return:
    
Help on function d in module __main__:


d(i, j)
    这个函数实现一个乘法运算。
    :param i:
    :param j:
    :return: