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

Question

我正在寻找可以自动为我生成docstrings框架的Python IDE。 例如：

def GetTextByCtrlName(self, _hwnd, _ctrName):
        '''
        @desc:

        @param:
             _hwnd 
             _ctrName  
        '''

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

Answer 1

自1.5版以来， PyCharm就已支持此功能。

首先，配置要生成文档字符串的格式。 按CTRL + ALT + S （在Windows上），在“项目设置”>“ Python集成工具”中选择格式。

您的选择是普通的，Epydoc或reStructuredText

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

Answer 2

您可以使用Sphinx之类的工具。 尽管它没有提供友好的IDE集成，但它专为记录python代码而设计。