python整理笔记3---__doc__(文档字符串)

1、定义

如果将一个字符串作为函数的第一部分，而没有名称去引用它，python将它存储在函数中，以便以后可以引用它，这个字符串通常叫做docstring,是documentation string(文档字符串)的缩写。简单的说就是给函数一个描述。

<span style="font-size:24px;">def add(a,b):
    """this a function to additon"""   #文档字符串
    sum = a+b
    return sum</span><span style="font-size:18px; ">
 </span>

2、显示

文档字符串通过函数名称后加英文句点显示

正确显示：

<span style="font-size:24px;">>>> print("%s" % add.__doc__)
this a function to additon
>>> </span>

错误显示：

<span style="font-family:SimSun;">>>> print("%s" % add._doc_)
Traceback (most recent call last):
  File "<pyshell#1>", line 1, in <module>
    print("%s" % add._doc_)
AttributeError: 'function' object has no attribute '_doc_'
>>> </span>

注意：__doc__前后各有两个下划线