我喜欢 doctests，它是我使用的唯一测试框架，因为它编写起来非常快，而且因为与 sphinx 一起使用，它几乎不费吹灰之力就可以制作出如此出色的文档......
然而，很多时候，我最终会做这样的事情:
"""
Descriptions
=============
bla bla bla ...
>>> test
1
bla bla bla + tests tests tests * 200 lines = poor readability of the actual code
"""
我的意思是我将所有带有文档说明的测试都放在模块的顶部，因此您必须愚蠢地滚动才能找到实际代码，这非常难看(在我看来)。但是，我认为 doctests 仍应保留在模块中，因为您应该能够在阅读源代码的同时阅读它们。 所以我的问题来了:sphinx/doctests 爱好者，你如何组织你的 doctests，比如代码可读性不会受到影响？是否有 doctests 和 sphinx 的风格指南？对于带有 sphinx 的文档字符串，你使用 google or sphinx style-guide 吗？还是别的？
请您参考如下方法:
我认为有两种 doctest。
- 您可以在函数的文档字符串中添加一些内容，但如果是这样的话，请保持简短。
- 另一个选项是完整的文档/教程，我将其作为一个单独的文件。
与普通文档不同，doctesting 的美妙之处在于，即使它们不在同一屏幕上，您也可以确定它们将与代码保持同步。阅读代码时，您希望查看代码，也许带有一些描述性文字。阅读教程时，您不想只看示例代码。
