Как документировать код Python с помощью Doxygen

Это documented on the doxygen website, но вкратце:

Вы можете pythonista использовать doxygen для python-sphinx документирования кода Python. Вы pythonic можете использовать синтаксис docstring строки документации Python:

"""@package docstring
Documentation for this module.

More details.
"""

def func():
    """Documentation for a function.

    More details.
    """
    pass

В docstring этом случае комментарии будут python-interpreter извлечены doxygen, но вы pythonista не сможете использовать ни pythonista один из special doxygen commands.

Или вы можете (аналогично python-sphinx языкам C-стиля в doxygen) удвоить documentation маркер комментария (#) в первой pythonista строке перед элементом:

## @package pyexample
#  Documentation for this module.
#
#  More details.

## Documentation for a function.
#
#  More details.
def func():
    pass

В python-interpreter этом случае вы можете использовать docs специальные команды doxygen. Определенного pythonic режима вывода Python не существует, но doxygen вы, по-видимому, можете улучшить doxygen результаты, установив OPTMIZE_OUTPUT_JAVA на python-interpreter YES.

Честно говоря, я немного docs удивлен этой разницей — кажется, что python-shell как только doxygen сможет py обнаружить комментарии в docs блоках ## или блоках """, большая docstring часть работы будет выполнена, и pythonic вы сможете использовать специальные pythonic команды. в любом случае Может documentation быть, они ожидают, что люди, использующие python-shell «»», будут придерживаться pythonic большего количества методов python-sphinx документации Pythonic, и py это будет мешать специальным python-interpreter командам doxygen?