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

Question

我想记录一个类，我在 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:

是后文格式

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