Python Pycharm中@param和:param的区别是什么
我想记录一个类,我在PyCharm中看到,当自动添加docstring时,它会添加Python Pycharm中@param和:param的区别是什么,python,pycharm,docstring,Python,Pycharm,Docstring,我想记录一个类,我在PyCharm中看到,当自动添加docstring时,它会添加 :param param_name1: :param param_name2: 然而,我看到一些人使用 @param param_name1: @param param_name2: 我想知道这两者中哪一个是有效的,哪一个是蟒蛇学家应该拥有的 我还想知道是否应该使用@type或:type来描述参数的数据类型 """ :type rating: int :param rating: hotel rating
:param param_name1:
:param param_name2:
然而,我看到一些人使用
@param param_name1:
@param param_name2:
我想知道这两者中哪一个是有效的,哪一个是蟒蛇学家应该拥有的
我还想知道是否应该使用@type
或:type
来描述参数的数据类型
"""
:type rating: int
:param rating: hotel rating
"""
这就是我编写文档字符串的方式。那么,这样做可以吗,还是有更好的方法或立场呢?如中所述
是重新构造的DTEXT格式,而不是
@param param_name1:
@param param_name2:
是超文本格式
可以使用文件>设置>Python集成工具启用超文本格式,并将“Docstring format”设置为“Epytext”我应该包括:类型还是可选?我希望在我的代码中有最佳实践。我认为你应该,是的
@param param_name1:
@param param_name2: