Автоматически генерировать фиктивную документацию в исходном коде для Python в eclipse - PullRequest
Новая
       18

Автоматически генерировать фиктивную документацию в исходном коде для Python в eclipse

5 голосов
/ 21 сентября 2011

В то время я документировал большую часть своего кода (Python), и мне было интересно, есть ли плагин для Eclipse, который может автоматически генерировать строку документа для моих функций, как Visual Studio делает это для C # при написании /// по методу.

Я искал решение, но мне не повезло - кто-нибудь из вас знает решение?

Пример:

Из моего списка параметров для метода будет создана фиктивная документация под моим определением метода, как показано ниже: 

def myFunction(self, a, b):
    """

    :param a:
    :type a:
    :param b:
    :type b:
    :return:
    :rtype:
    """
    return 'Hello, world'

1 Ответ

6 голосов
/ 21 сентября 2011

Ну, согласно этому документу , если вы нажмете Ctrl + 1 на имени метода, вы получите то, что вам нужно.

Для вашего примера (РЕДАКТИРОВАТЬ: если вы установите параметр PyDev> Редактор> Стиль кода> Строки документов> Генерация Doctag, чтобы всегда получать тип параметра), вы получите: 

def myFunction(self, a, b):
    '''

    @param a:
    @type a:
    @param b:
    @type b:
    '''
    return 'Hello, world'
...