Python PyCharm:如何在快速文档弹出窗口中列出类属性?

Python PyCharm:如何在快速文档弹出窗口中列出类属性?,python,pycharm,documentation,docstring,Python,Pycharm,Documentation,Docstring,我发现Quick文档没有显示类“docsting”中列出的属性,这真的很烦人。我认为原因是docstring格式不正确或不受支持,但reST和Google样式的行为是相同的(我在Python集成工具中正确设置了它们) 我当前的docstring样式是Google。让我展示一下图片中的错误: 这是演员课。 如您所见,属性部分显示在docstring中,但不在快速文档弹出窗口中 此外,属性world\u id上没有注释。 \uuuu init\uuuu的Args识别就像一个符咒。 让我们将do

我发现Quick文档没有显示类“docsting”中列出的属性,这真的很烦人。我认为原因是docstring格式不正确或不受支持,但
reST
Google
样式的行为是相同的(我在
Python集成工具中正确设置了它们)


我当前的docstring样式是
Google
。让我展示一下图片中的错误:

这是演员课。 如您所见,
属性
部分显示在docstring中,但不在快速文档弹出窗口中

此外,属性
world\u id
上没有注释。

\uuuu init\uuuu
Args
识别就像一个符咒。

让我们将docstring直接添加到属性中(如中所建议的)。很好用,不是吗?

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


如何让事情正常运行?如何设置PyCharm,使其能够赶上类的属性并在快速文档中显示它们


PyCharm 2018.2.4(社区版)。Ubuntu 16.04。

适用于那些仍在努力解决这个问题并偶然发现这篇文章的人(就像我一样)

PyCharm目前不支持这一点,或者我更应该说它仍然不支持这一点。不适用于Google样式的docstring,也不适用于structuredText。Youtrack支持网站上有多张关于此问题的票证


这个问题已经存在5年多了

以下是我如何在Pycharm 2020.3.3(我使用专业版)的Docstring中显示类属性:

请注意,如果没有
属性:
行,它将无法按预期工作

这是quick文档中的显示方式:


在PyCharm文档中,它说“PyCharm识别根据“@lmiguelvargasf”创建的内联文档,PEP-257中有一行:“类的docstring应该总结其行为并列出公共方法和实例变量”。我想这就足够让PyCharm识别属性了。更像Python的方式是:
name::class:`str`
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)