Question

上一小节的示例包含了其模块的一个文档字符串，但是，别忘了，文档字符串也可以用于类的部分。我们在第15章详细介绍了文档字符串，它是出现在各种结构的顶部的字符串常量，由Python在相应对象的__doc__属性自动保存。它适用于模块文件、函数定义，以及类和方法。

既然我们了解了有关类和方法的知识，如下的文件docstr.py提供了一个快速但全面的示例，来概括文档字符串可以在代码中出现的位置。所有的这些都可以是三重引号的块：

文档字符串的主要优点是，它们在运行时能够保持。因此，如果它们已经编写为文档字符串，可以用其__doc__属性来获取文档：

第15章讨论了PyDoc工具，该工具知道如何格式化报表中的所有这些字符串。如下是在Python 2.6下运行我们代码的情况（Python 3.0还显示从新式类模式的隐含object超类继承来的额外属性，请自己在Python 3.0下运行它，关于其差别的更多讨论参见第31章）：

文档字符串在运行时可用，但是，它们从语法上比#注释（它可以出现在程序中的任何地方）要缺乏灵活性。两种形式都是有用的工具，并且任何程序文档都是很好的（当然，只要它够准确）。作为首要的最佳实践规则是：针对功能性文档（你的对象做什么）使用文档字符串；针对更加微观的文档（令人费解的表达式是如何工作的）使用#注释。