我正在寻找可以自动为我生成文档字符串框架的 Python IDE。例如:
def GetTextByCtrlName(self, _hwnd, _ctrName): ''' @desc: @参数: _hwnd _ctrName '''
然后我就可以填写相应的内容了。
PyCharm从 1.5 版开始支持这一点。
首先,配置您希望生成文档字符串的格式。点击CTRL
++ (在 Windows 上ALT
)S
,在 Project Settings > Python Integrated Tools 中选择格式。
您的选择是普通的、Epydoc 或 reStructuredText
配置完成后,确保您的光标位于方法名称上,然后按Alt
+ Enter
。
您可以使用像Sphinx这样的工具。它旨在专门记录 python 代码,尽管它不提供友好的 IDE 集成。