如果模块、类或者函数的定义的第一条语句是一个字符串。该字符串就成了其对应的说明文档字符串。

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

如下所示:

def mark():
    "这是一个函数哦"
    pass

print(mark.__doc__)

结果:

这是一个函数哦

注意:

文档字符串的缩进必须与其它所有其它语句保持一致,另外,文档字符串不能通过表达式进行计算或者通过变量进行赋值。

results matching ""

    No results matching ""