Pycharm中@param和：param有什么区别？

Question

我想记录一个类，我在PyCharm中看到，当自动添加docstring时它会添加

:param param_name1: 
:param param_name2:

但是，我看到有些人使用

@param param_name1:
@param param_name2:

我想知道哪一个都有效，哪一个是Pythonista应该容纳的那个。

我也想知道是否应该包含@type或:type来描述参数的数据类型。

"""
:type rating: int
:param rating: hotel rating
"""

这就是我编写文档字符串的方式。那么，它是否可以，或者有更好的方式或方式来做它？

Answer 1

如https://www.jetbrains.com/pycharm/help/using-docstrings-to-specify-types.html#d331661e129

中所述

:param param_name1: 
:param param_name2:

是reStructuredText格式而不是

@param param_name1:
@param param_name2:

是Epitext格式

可以使用File＆gt;启用Epitext格式设置＆gt; Python集成工具和set＆＃34; Docstring格式＆＃34;到＆＃34; Epytext＆＃34;