Кодовая документация для python

Ответ 1

Epydoc также является хорошим инструментом для документирования исходного кода и обработки перекрестных ссылок классов, модулей, переменных и т.д. в HTML, PDF, LaTeX. Рисует некоторые хорошие диаграммы наследования классов. Он использовался рядом проектов с открытым исходным кодом, поэтому он довольно активно развивается.

Ответ 2

Соглашения: PEP 257 и PEP 8. Обратите внимание, что docstrings можно записать в reStructuredText

Инструменты для генерации документации: например Sphinx

Ответ 3

Сначала добавьте комментарии в свои docstrings, используя формат RestructuredText.

Во-вторых, получите sphinx.

В-третьих, создайте индекс, который использует расширение autodoc.

Затем запустите Sphinx, чтобы получить действительно хорошую документацию.

Ответ 4

Очень приятно размещать документацию кода в самом коде. См:

• PEP 257 - Доключительные соглашения
• PEP 8 - Руководство по стилю для кода Python

Ответ 5

Использование doxypy-фильтра с doxygen - это тоже хорошо.