Правильно оформлена документация данного примера класса?
class Example:
def __init__(self, label="", icon=None, menu=None, quit=True):
"""
:param label: подпись трея
:type icon: str
:param icon: путь к иконке
:type menu: list
:param menu: [("Подпись кнопки", пользовательская функция))]
:param quit: если True - будет создан пункт "Quit" с функцией выхода
"""
Если нет, подскажите, как это сделать грамотно, чтобы не было стыдно за свой код.
Ответ
Раз уж Вы задались подобным вопросом, советую вам почитать перевод статей про оформление кода на языке Python отсюда. Хоть определенного (единого) стандарта на этот счет и нет, однако, окружать аргумент с 2-х сторон - это, по-моему, лишнее. Достаточно ставить один знак , например, так: param label: Подпись трея Подробенее см. ссылку.
Комментариев нет:
Отправить комментарий