PyCharm：如何获取要在快速文档弹出窗口中列出的类属性？

Question

我发现这真的很烦人，快速文档没有显示属性，列在类的文档中。我认为原因是不正确或不受支持的文档字符串格式，但是reST和Google样式的行为是相同的（我在 中正确设置了它们Python Integrated Tools）。

---

我目前的文档字符串样式是Google. 让我来看看图片中有什么问题：

这里是Actor课。 如您所见，Attributes部分出现在文档字符串中，但不在快速文档弹出窗口中。

此外，属性上没有注释world_id。

Args的__init__认识就像一个魅力。

让我们将 docstring 直接添加到属性（在answer 中是如何建议的）。效果很好，不是吗？

并在另一个方法中调用属性的快速文档。哇，又没有描述了。

---

如何让事情发挥作用？如何设置 PyCharm 使其赶上类的属性并在快速文档中显示它们？

PyCharm 2018.2.4（社区版）。Ubuntu 16.04。

Answer 1

以下是我如何在 Pycharm 2020.3.3（我使用专业版）的 Docstring 中显示类属性：

class TestModel(models.Model):
    """
    A Test model to see the class attributes in the docstring

    Attributes:

    - :class:`str` name --> The name of the test object
    - :class:`datetime` created_at --> Date and time when the instance was created
    """
    name = models.CharField(max_length=50)
    created_at = models.DateTimeField(auto_now_add=True)

请注意，如果没有这条Attributes:线，它将无法按预期工作。

这就是快速文档中的显示方式：

Answer 2

对于那些仍在为此苦苦挣扎并偶然发现这篇文章的人（就像我一样）。

PyCharm 目前不支持这一点——或者我应该说它仍然不支持。不适用于 Google 风格的文档字符串，也不适用于结构化文本。Youtrack 支持网站上有多个关于此问题的票证。

例如https://youtrack.jetbrains.com/issue/PY-17945 - 这个问题已经存在 5 年多了！