用於自動完成文檔字符串的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代碼而設計。