Как документировать типы параметров функции Python?

Я знаю, что параметрами могут быть любые объекты, но для документации очень важно указать, что вы ожидаете.

Во-первых, как определить типы параметров, подобные этим ниже?

str (или использоватьString или жеstring?)intlistdictФункция ()tupleэкземпляр объекта классаMyClass

Во-вторых, как указать параметры, которые могут быть нескольких типов, например, функция, которая может обрабатывать один параметр, который может бытьint или жеstr?

Пожалуйста, используйте приведенный ниже пример, чтобы продемонстрировать синтаксис, необходимый для документирования этого с вашим предлагаемым решением. Имейте в виду, что желательно иметь возможность ссылаться на ссылку на класс «Image» из документации.

def myMethod(self, name, image):
    """
    Does something ...

    name String: name of the image
    image Image: instance of Image Class or a string indicating the filename.

    Return True if operation succeeded or False.
    """
    return True

Обратите внимание, что вы можете предложить использовать любой инструмент для документирования (сфинкс, кислород, ...), если он способен соответствовать требованиям.

Обновить:

Похоже, что есть некоторая поддержка для документирования типов параметров в doxygen в общем. Приведенный ниже код работает, но добавляет раздражающее значение $ к имени параметра (потому что он изначально был создан для php).

    @param str $arg description
    @param str|int $arg description

Ответы на вопрос(6)

Ваш ответ на вопрос