docstrings

docstrings

美 　英

• 网络文档字符串；文档注释；文件字串

例句

it's good practice to include docstrings in code that you write, so make a habit of it.

在您编写的代码中加入文档字符串是个很好的做法，因此请养成编写文档字符串的习惯。

First, much of the work done by a concrete class is specified in the docstrings of methods.

首先，具体类所完成的大部分工作都在方法的文档字符串（docstring）中指定。

The docstrings processed by doctest can contain tracebacks within them, but a better approach to special cases is to utilize unittest.

由doctest处理的文档字符串可能会在其内部包含回溯（traceback），但是在特别的情况下，更好的方法是使用unittest。

The main element of good Python documentation is the use of so-called "docstrings. "

Python文档之所以“优秀”的主要因素是使用所谓的“docstring”。

If you follow the standard Python coding conventions using Docstrings, you will automatically have a solid foundation for documentation.

如果通过使用Docstring遵守标准的Python代码约定，就为生成文档建立了牢固的基础。

When they occur inside of docstrings inside of Python source code, like in the second example, they are called doctests.

当它们出现在Python源代码中的docstring中时（比如第二个示例），它们就被称为doctest。