python - 如何使用 sphinx-apidoc 记录 Python 函数参数？

Question

我正在尝试清理我的 python 代码文档，并决定使用sphinx-doc，因为它看起来不错。我喜欢如何使用以下标签引用其他类和方法：

:class:`mymodule.MyClass` About my class.
:meth:`mymodule.MyClass.myfunction` And my cool function

我试图弄清楚如何在函数中记录参数名称，以便如果我有如下函数：

def do_this(parameter1, parameter2):
   """
   I can describe do_this.

   :something?:`parameter1` And then describe the parameter.

   """

这方面的最佳做法是什么？

更新：

正确的语法是：

def do_this(parameter1, parameter2):
   """
   I can describe do_this.

   :something parameter1: And then describe the variable
   """

score 11 · Accepted Answer

通常，“函数变量”被称为参数；）。

答案是:param ________

编辑免责声明：我从未使用或听说过狮身人面像……这篇文章主要是“要搜索的词”。希望它有所帮助。

score 6 · Accepted Answer

添加此答案以合并选项：

pydoc是基本的，没有特殊格式

epydoc使用格式 '@param var:'

Doxygen面向更广泛的语言

Sphinx使用格式 ':param type var:'。另请参阅更多示例。这用于创建Python 3.5 文档。

2 回答 2