我发现这真的很烦人,快速文档没有显示属性,列在类的文档中。我认为原因是不正确或不受支持的文档字符串格式,但 reST
的行为是相同的和 Google
样式(我在 Python Integrated Tools
中正确设置了它们)。
我当前的文档字符串样式是 Google
.让我来看看图片中有什么问题:
这是Actor
类(class)。
如您所见,Attributes
部分出现在文档字符串中,但不在快速文档弹出窗口中。
此外,属性 world_id
上没有注释。 .
Args
的 __init__
认可就像一种魅力。
让我们将 docstring 直接添加到属性(在 answer 中是如何建议的)。效果很好,不是吗?
并在另一个方法中调用属性的快速文档。哇,又没有描述了。
如何让事情发挥作用? 如何设置 PyCharm 使其 catch 类的属性并在快速文档中显示它们?
PyCharm 2018.2.4(社区版)。 Ubuntu 16.04。
最佳答案
对于任何仍在为此苦苦挣扎并偶然发现这篇文章的人(就像我一样)。
PyCharm 目前不支持这个——或者我应该说它仍然不支持它。不适用于 Google 样式的文档字符串,也不适用于结构化文本。他们的 Youtrack 支持网站上有多个关于此问题的票证。
例如。 https://youtrack.jetbrains.com/issue/PY-17945 - 这个问题已经存在超过 5 年了!
关于python - PyCharm:如何获取要在快速文档弹出窗口中列出的类属性?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/52844553/