Тег строки документации для ключевого слова yield

В Python есть несколько тегов для строк документации, например @param и @return , например:

def my_method(a_param):
    ''' @param a_param: Description of this param
        @return: The return value of the method
    '''
    return int(a_param) * (other or 1)

Что я могу использовать для документирования генераторы? особенно ключевое слово yield , например:

def my_generator(from=0):
    ''' @param from: The initial value
        @yield: A lot of values
    '''
    yield a_value

Я понимаю, что здесь можно использовать @return an итератор , но я не знаю, правильно ли это, потому что генератор также может возвращать значения .

Спасибо.

14
задан alfonso.kim 4 October 2011 в 18:39
поделиться