用于自动完成文档字符串的Python IDE

Question

我正在寻找一个可以自动为我生成文档字符串框架的Python IDE。 例如：

 def GetTextByCtrlName(self, _hwnd, _ctrName):
        '''
        @描述：

        @参数：
             _hwnd 
             _ctr名称  
        '''
        

然后我就可以填写相应的内容了。

Answer 1

PyCharm从 1.5 版本开始支持此功能。

首先，配置您想要生成文档字符串的格式。点击

CTRL

+

ALT

+

S

（在 Windows 上），在项目设置 > Python 集成工具中选择格式。

您的选择是 plain、Epydoc 或 reStructuredText

配置完成后，确保光标位于方法名称上，然后按

Alt

+

Enter

。

Answer 2

使用 VSCode 并尝试扩展“trelent”来创建文档字符串。我已经在 python 中使用它有一段时间了，它确实很有帮助。

Answer 3

您可以使用像Sphinx这样的工具。它旨在专门记录 Python 代码，尽管它不提供友好的 IDE 集成。