本节书摘来自异步社区《Python参考手册(第4版•修订版)》一书中的第2章,第2.7节,作者David M. Beazley,更多章节内容可以访问云栖社区“异步社区”公众号查看。
2.7 文档字符串
如果模块、类或函数定义的第一条语句是一个字符串,该字符串就成为了相关对象的文档字符串,如下所示:
def fact(n):
"This function computes a factorial"
if (n <= 1): return 1
else: return n * fact(n - 1)
代码浏览工具和文档生成工具有时会用到文档字符串。通过对象的__doc__属性可以访问文档字符串,如下所示:
>>> print fact.__doc__
This function computes a factorial
>>>
文档字符串的缩进必须与定义中的所有其他语句保持一致。另外,文档字符串不能通过表达式进行计算或者通过变量进行赋值。文档字符串必须是包含在引号中的字符串字面量。