无论如何,我仍然不能对函数文档字符串风格的解析器具有太多热情。
首先,具体类所完成的大部分工作都在方法的文档字符串(docstring)中指定。
函数执行文档字符串测试的转换。
Python文档之所以“优秀”的主要因素是使用所谓的“docstring”。
每个这样的方法的文档字符串都包含一个或多个模式到名称的分配。
如果通过使用Docstring遵守标准的Python代码约定,就为生成文档建立了牢固的基础。
当它们出现在Python源代码中的docstring中时(比如第二个示例),它们就被称为doctest。
这种说明还可以出现在源代码中模块、类或函数的docstring中