时间戳

首页 > 解决方案 > PyCharm：如何获取要在快速文档弹出窗口中列出的类属性？

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

问题描述

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

我当前的文档字符串样式是Google. 让我展示图片中的问题：

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

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

Args认可__init__就像一种魅力。

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

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

如何让事情顺利进行？如何设置 PyCharm 使其赶上类的属性并在快速文档中显示它们？

PyCharm 2018.2.4（社区版）。Ubuntu 16.04。

标签： pythonpycharmdocumentationdocstring

解决方案

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

PyCharm 目前不支持这个 - 或者我应该说它仍然不支持它。不适用于 Google 样式的文档字符串，也不适用于结构化文本。在他们的 Youtrack 支持网站上有很多关于这个问题的票。

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

推荐阅读