Fatal编程技术网
  • python/
  • 如何将代码片段添加到python docstring（而不是作为doctest）？

如何将代码片段添加到python docstring（而不是作为doctest）？

python

如何将代码片段添加到python docstring（而不是作为doctest）？,python,code-snippets,docstring,doctest,code-documentation,Python,Code Snippets,Docstring,Doctest,Code Documentation,我想提供一些代码片段来演示如何在python中使用特定的方法或类。我该怎么做 在Java中可以使用以执行此操作 Here is something I want to talk about:: <-- Special syntax to mark code beginning def my_fn(foo, bar=True): # Code itself """A really useful function. Returns None

我想提供一些代码片段来演示如何在python中使用特定的方法或类。我该怎么做

在Java中可以使用
以执行此操作


Here is something I want to talk about:: <-- Special syntax to mark code beginning

    def my_fn(foo, bar=True): # Code itself
        """A really useful function.

        Returns None
        """


医生测试是唯一的方法？

当我查看典型软件包（例如，pandas、numpy等）的现有docstring时，除了doctest之外，我从来没有看到任何其他东西，它旨在测试方法，而不仅仅是将文本格式化为python代码。那么，如果doctest是唯一的方法，那么将代码片段格式化为交互式python会话的正确方法是什么？我不想每次都在交互式会话中编写代码，然后在我的docstring中使用c+p。这似乎不对。
docstring不是唯一的方法。如果您正在使用Sphinx生成文档，那么您可以

范例


以下是我想谈的事情：：这很好。但是如果可能的话，我更愿意避免文档依赖于另一个包。我注意到，
：
可以在不需要安装任何包的情况下工作。所以，我将接受你的回答。