The main element of good Python documentation is the use of so-called "docstrings."
Python 文档之所以“优秀”的主要因素是使用所谓的“docstring”。
First, much of the work done by a concrete class is specified in the docstrings of methods.
首先,具体类所完成的大部分工作都在方法的文档字符串(docstring)中指定。
When they occur inside of docstrings inside of Python source code, like in the second example, they are called doctests.
当它们出现在python源代码中的docstring中时(比如第二个示例),它们就被称为doctest。
应用推荐