Docstrings explain how to use code, and are for the users of your code.
文档说明用来解释代码是如何工作的，是写给读代码的人看的。
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。
The docstrings processed by doctest can contain tracebacks within them, but a better approach to special cases is to utilize unittest.
由doctest 处理的文档字符串可能会在其内部包含回溯（traceback）,但是在特别的情况下，更好的方法是使用unittest 。
There are tools which use docstrings to automatically produce online or printed documentation, or to let the user interactively browse through code;
有些文档字符串工具可以在线处理或打印文档，或让用户交互的浏览代码；
Choosing — doctest-tests is the least intrusive option, and simply asks nose to watch out for doctests in the docstrings of the test modules that it is already examining.
doctest -tests是干扰最小的选项，它只要求nose在已经检查的测试模块的docstring中寻找doctest。
Choosing — doctest-tests is the least intrusive option, and simply asks nose to watch out for doctests in the docstrings of the test modules that it is already examining.
doctest -tests是干扰最小的选项，它只要求nose在已经检查的测试模块的docstring中寻找doctest。
应用推荐