Мы можем указать типы параметров функции, используя docstring в python:
def f1(a):
"""
:param a: an input.
:type a: int
:return: the input integer.
:rtype: int
"""
return a
Для f1
autodoc генерирует следующий документ:
fun1(a)
Parameters : a (int) – an input.
Returns : the input integer.
Return type: int
В python 3 типы также могут быть указаны подсказкой типа:
def f2(a: int):
"""
:param a: an input.
:return: the input integer.
:rtype: int
"""
return a
Когда мы запускаем autodoc, он ставит тип по объявлению параметра, а не по описанию:
f2(a: int)
Parameters : a – an input.
Returns : the input integer.
Return type: int
Можно ли сгенерировать документацию как f1
, используя аннотацию вместо строки документации? Я использую питон 3.6. Благодарю вас!