Я ищу Python IDE, который может автоматически генерировать для меня структуру docstrings. Например:
def GetTextByCtrlName(self, _hwnd, _ctrName):
'''
@desc:
@param:
_hwnd
_ctrName
'''
Тогда я могу просто заполнить соответствующий контент.
PyCharm поддерживает это, начиная с версии 1.5.
Во-первых, настройте формат, в котором вы хотите создать строку документации. Нажмите CTRL+ALT+S (в Windows), выберите формат в разделе «Настройки проекта» > «Интегрированные инструменты Python».
Ваш выбор: простой, Epydoc или reStructuredText
После настройки убедитесь, что ваш курсор находится на имени метода, и нажмите Alt+Enter.
Вы можете использовать такой инструмент, как Sphinx. Он разработан специально для документирования кода Python, хотя и не предлагает удобную интеграцию с IDE.
