文档字符串

来源:互联网 发布:淘宝听诊器 编辑:程序博客网 时间:2024/06/06 06:43

文档字符串


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

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

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

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


#文档字符串def d(i,j):    '''    这个函数实现一个乘法运算。    :param i:    :param j:    :return:    '''    k=i*j    return kprint  d.__doc__help(d)

输出:

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


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