我总是在函数定义中使用类型提示,例如:
def foo(a: int, b: str) -> bool:
pass
当我使用 PyCharm 自动文档字符串生成器在代码中生成文档字符串时,我得到以下信息:
def foo(a: int, b: str) -> bool:
"""
:param a:
:type a:
:param b:
:type b:
"""
pass
正如您所看到的,我在函数本身中定义的类型值尚未被 PyCharm 识别,我应该再次将它们写入文档字符串中。我如何让 PyCharm 为我自动生成这样的东西(从第一行读取类型值并将它们插入到文档字符串中):
def foo(a: int, b: str) -> bool:
"""
:param a:
:type a: int
:param b:
:type b: str
:rtype: bool
"""
pass
PyCharm Bugtracker 上有一个功能请求:根据现有的内联注释生成文档字符串类型 https://youtrack.jetbrains.com/issue/PY-32837
截至 2020 年底,PyCharm 似乎仍然不支持将方法中的类型信息自动添加到文档字符串中。
功能请求中有一条评论询问为什么需要这样的功能:
下面的每个人都有一个问题,为什么需要在注释和文档字符串中添加类型提示? PyCharm 仅部分支持后一种格式(并非所有可能的 PEP 484 类型提示都能被理解,请参阅 PY-23400),并且大多数其他类型检查器根本无法识别。另一方面,注释中的类型提示已经在快速文档和 Sphinx 呈现的文档中正确显示(可能在 sphinx-autodoc-typehints 的帮助下)。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)