什么是文档字符串?

它在Python中的作用是为函数、模块和类注释生成文档。他是对象的”__doc__”属性,是一个字符串文本, 是作为模块,函数,类或方法定义中的第一个语句出现。

他是使用三重引号包含起来,有单行和多行文档字符串两种形式。 如果是多行文档字符串,那第一行为总述,第二行应当为空行。

示例:

>>> def fn():
...     """ hello function"""
...     pass
...
>>> fn.__doc__
' hello function'

通过函数对象的__doc__属性可以访问文档字符串。

python支持单引号,双引号和三引号来包含字符串。单引号和双引号功能完全相同。 如果是引用 的内容里面包含单引号,那就使用双引号来引用。如果引用的内容包含双引号,那就使用单引号 引用字符串,这可以避免转义字符。单引号和双引号不能包含换行,因此引入三重引号。三重引号 通常用来生成文档字符串。