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

Что имеется в соглашениях и инструментах для документирования исходного кода python?

    5 Solutions collect form web for “кодовая документация для python”

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

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

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

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

    Во-вторых, получите сфинкс .

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

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

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

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

    использование doxypy фильтра с doxygen – тоже хорошо

    Python - лучший язык программирования в мире.