Codedokumentation für Python

Question

Was gibt es auf Konventionen und Tools für die Dokumentation von Python-Quellcode?

Answer 1

Epydoc ist auch ein gutes Werkzeug für den Quellcode zu dokumentieren, und übernimmt die Querverweise von Klassen, Module, Variablen, usw., in HTML, PDF, LaTeX. Zeichnet auch einige nette Klassenvererbungsdiagramme. Es wird von einer Reihe von Open-Source-Projekten verwendet, daher ist es ziemlich aktiv entwickelt.

Answer 2

Konventionen: PEP 257 und PEP 8. Hinweis, dass Docstrings zur Erzeugung von Dokumentation in reStructuredText

Werkzeugen geschrieben werden: zum Beispiel Sphinx

Answer 3

Es ist sehr schön Code-Dokumentation in dem Code selbst zu setzen. Siehe:

• PEP 257 -- Docstring Conventions
• PEP 8 -- Style Guide for Python Code

Answer 4

Geben Sie zuerst Kommentare in Ihre Docstrings mit dem RestructuredText-Format ein.

Zweitens, erhalten sphinx.

Drittens erstellen Sie einen Index, der die autodoc extension verwendet.

Dann laufen Sphinx, um wirklich schöne Dokumentation zu bekommen.

Answer 5

mit Doxypy-Filter mit Doxygen ist eine gute Sache auch