Как включить выходные данные в строку документации формата pep8

Question

Стандартная строка документации pep8 в соответствии с руководством по стилю для python может выглядеть следующим образом:

"""Function description

Keyword arguments:
keyword_arg_1 -- description
keyword_arg_2 -- description
"""

Однако я ничего не вижу в стандарте для возвращаемых выходных данных, и я считаю, что это является важной частью определения функции. я хочу задокументировать каждую переменную, перед которой стоит оператор return.

Каков хороший стандартный способ также предоставить описание и тип для каждой возвращаемой функции, выводимой в python?

Answer 1

Поскольку вы используете pycharm, просто определите функцию и поставьте 3 " сразу после def, нажмите ввод, и он автоматически сгенерирует для вас строку документации, включая возвращаемые данные. Вы также можете выбрать до 5 форматов документов, перейдя на Settings > Tools > Python Integrated Tools > Docstring format. Я не знаю, можем ли мы настроить его или нет, но я думаю, что то, что они предоставляют, достаточно