python -- 文档字符串


改变的东西,一定有其意义


文档字符串定义

在函数体的第一行,我们可以使用一对三个单引号(''')或者一对三个双引号(""")来定义文档字符串,文档字符串通常第一行以大写字母开头,以句号(.)结束,第二行是空行,第三行开始是详细描述

文档字符串的作用在于能够很直观地表示出函数或者类的作用,而不用通过源代码来获知,节省使用者的精力时间


与注释的区别

虽然文档字符串使用的也是注释符,但是不同的是,注释在解释器中会直接被忽视掉,但是文档字符串可以被调用使用


实例

>>> def maxnum(x,y):
...     """ get the max number between x and y.
...
...     x and y much be integer."""
...
...     if x>y:
...         return x
...     else:
...         return y
...

使用

>>> help(maxnum)
Help on function maxnum in module __main__:

maxnum(x, y)
    get the max number between x and y.

    x and y much be integer.

>>> maxnum.__doc__
' get the max number between x and y.\n\n\tx and y much be integer.'