dokumentation

[newbe]

hi ich wollt mal fragen , ob es ein prog gibt, welches meine python programe dokumentiert.
und wenn ja wie es heißt

[henning]

Kommt drauf an, was genau du von dem Programm willst.
Ich mache es so, und ich denke, das ist wohl der "üblichste" Weg, dass ich das Programm im Code mit docstring dokumentiere und pydoc (müsste bei deinem Python dabei sein) macht daraus dann z.B. HTML-Dateien.

[newbe]

was heißt du dokumentierst im docstring.
kannste mir das mal erklären oder ein beispiel geben

[Leonidas]

Das kann ich machen:

Code: Alles auswählen

def zu_dokumentieren():
    """Ich bin ein docstring"""
    return True

Docstrings sind einfach die Strings in den Funktionen, die direkt unter der Deklaration stehen.

[ProgChild]

Mal noch nebenbei. Die Python Dokumentation ist in LaTeX geschrieben. Die Python Entwickler haben dafür ein Paar Makros geschrieben.

Alles nachzulesen hier.

[Leonidas]

Ich denke nicht, dass man zum Dokumentieren LaTeX nutzen sollte. Da wären docutils denke ich, schon besser.

[newbe]

hmm ja danke. das mit dem docstring mache ich ja eh schon.
aner ich möcjte jetzt noch das alles mögliche halt protokolliert wird, wenn möglich von einem program.
z.b dateiname..
welche klassen da drin sind usw.

Edit (Leonidas): Thread über Versionsverwaltungen geforkt, jedoch habe ich eine Antwort von Gerold übersehen. Tut mir Leid, ich hätte schon früher forken sollen.