Как указать типы входных и выходных данных в комментариях Python?

Если вы используете epydoc для datatype создания документации по python-interpreter API, у вас есть три варианта.

  • Эпитекст.

  • ReStructuredText, RST.

  • Нотация datatypes JavaDoc, немного похожая python-interpreter на эпитекст.

Я рекомендую comments RST, потому что он хорошо comment работает с sphinx для создания python-interpreter общего набора документации, который comments включает ссылки на API. Разметка documentation RST определяется here. Различные datatype поля epydoc, которые вы можете datatypes указать, определены here.

Пример.

def someFunction( arg1, arg2 ):
    """Returns the average of *two* (and only two) arguments.

    :param arg1: a numeric value
    :type arg1: **any** numeric type

    :param arg2: another numeric value
    :type arg2: **any** numeric type

    :return: mid-point (or arithmetic mean) between two values 
    :rtype: numeric type compatible with the args.
    """
    return (arg1+arg2)/2

python

documentation

comments

types

2022-08-23T02:13:14+00:00
Вопросы с похожей тематикой, как у вопроса:

Как указать типы входных и выходных данных в комментариях Python?