使用PyCharm在docstring中记录Python参数

Question

我在找出在Pycharm中记录方法以获得类型提示和参数描述的正确方法时遇到了一些麻烦.

:param"type_name""param_name":"param_description"

(1)但是,当我尝试使用它时,函数定义没有正确显示参数描述:

(2)如果我切换到带有@符号的前导,我会得到一个参数列表及其类型,但我没有得到参数说明:

(3)如果我坚持使用@符号并删除类型,我会得到参数说明:

(4)如果我明确地@type为每个添加@param(这完全炸掉了注释块的大小),一切正常(但我讨厌评论的大小):

(5)最后,为了完整起见,使用:而不是@导致一切都无法填充:

请注意,我已经尝试更改Pycharm中的文档系统,但它不会影响它呈现文档的方式 - 它似乎只会影响它为您自动填充注释块的方式.

如何实现文档尽可能接近紧凑的示例(1),但实际上是否正确填充了函数定义？我讨厌被风格困扰(4).

Answer 1

你检查过Settings...- Tools- Python integrated tools-Docstring format吗？您可以选择解析样式。

您可以选择：

Answer 2

它适用于最新版本的 PyCharm (2016.2 CE)，甚至在一些以前的修补版本中。

我问了类似的问题并得到了答案！