python IDE for auto-complete Docstring

问题描述:

我正在寻找一个Python IDE,它可以自动为我生成docstrings框架。 例如:python IDE for auto-complete Docstring

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

     @param: 
      _hwnd 
      _ctrName 
     ''' 
    

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

你可以使用一个工具,像Sphinx。它旨在专门记录Python代码,但它不提供友好的IDE集成。

+0

你能举一个例子如何使用Sphinx来实现OP所要求的? – Patrick 2017-07-06 05:24:02

PyCharm自1.5版本已经支持这一点。

首先,配置要生成的文档字符串格式。点击CTRL​​S(在Windows上),在项目设置> Python集成工具中选择格式。

你的选择是平原,epydoc的或新结构化

一旦被配置,确保你的光标位于方法名,然后按Alt + Enter