Python sphinx Python代码中注释和docstring的基本语法

我正在学习如何使用Sphinx为我的代码创建文档。在我看到一些这样的例子之后：

def复合体（real=0.0，imag=0.0）：
“”“形成一个复数。
关键字参数：
实部——实部（默认为0.0）
imag——虚部（默认值为0.0）
"""
如果imag==0.0且real==0.0：返回复数_零
...

评论中使用什么语言来让斯芬克斯理解并抓住他们？ 没有这种语法和逻辑，Sphinx在我的代码中看不到注释，当我生成HTML时，模块是空的

这里有一个例子：

您必须区分注释和文档字符串（完整称为“文档字符串”）

请参阅模块、函数、类和方法。对于提到的对象，您可以应用

您的\u对象。\uu doc\uu

以编程方式检索docstring；变量没有docstring

关于你的例子：

def复合体（real=0.0，imag=0.0）：
“”“形成一个复数。
关键字参数：
实部——实部（默认为0.0）
imag——虚部（默认值为0.0）
"""

Sphinx将检索的文档字符串中可以使用3种常见的语法：

reST是基本语法

Numpy样式的文档字符串

谷歌风格的文档字符串

---

通常是在Numpy或Google样式之间进行选择（目前，它们提供了更好的可读性和功能，并提供了样式指南）。要使这些功能正常工作，您需要使用，请查看官方文档中的概述。

非常好！我将开始学习Numpy风格，以便在我的代码中应用。需要任何导入才能使用此Numpy样式吗？或者斯芬克斯会理解自动？@HenriqueOliveiraCosta正如我在帖子中所说，你需要使用

pip

安装Napoleon扩展，并将其包含在你的

conf.py

中。