我正在寻找一种工具,可以将函数中已添加的类型注释添加到 PyCharm 生成的文档字符串中。
我在 JetBrains 上关注此问题已经很长时间了,但此票证似乎尚未取得任何进展。
我也看到了我已经在 PyPI 上查看了这个包,但这与我需要的相反。我需要的是将参数中提供的类型提示添加到文档字符串,而不是相反。
这可能与如何使 PyCharm 从函数定义中获取类型提示并在文档字符串中填充类型值?有关,但我只需要一个通用解决方案,或者至少一个与 Numpy 文档字符串或 reStructuredText 一起使用并且可能运行良好的解决方案使用 PyCharm。
我只是看到自己回来研究这个东西,希望能得到一些东西,但找不到我需要的东西。什么工具可以用于此?
this 扩展的 VS Code,它提供了很好的文档字符串:
def foo(a: int, b: str) -> bool:
"""[summary]
Args:
a (int): [description]
b (str): [description]
Returns:
bool: [description]
"""