@param 和: param in Pycharm 有什么区别

Question

我想记录一个 class，我在 PyCharm 中看到当自动添加文档字符串时它会添加

: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 格式

Epitext 格式可以通过文件 > 设置 > Python 集成工具启用，并将 "Docstring format" 设置为 "Epytext"