dokumentation

Wenn du dir nicht sicher bist, in welchem der anderen Foren du die Frage stellen sollst, dann bist du hier im Forum für allgemeine Fragen sicher richtig.
Antworten
newbe

Sonntag 16. Oktober 2005, 17:27

hi ich wollt mal fragen , ob es ein prog gibt, welches meine python programe dokumentiert.
und wenn ja wie es heißt
henning
User
Beiträge: 274
Registriert: Dienstag 26. Juli 2005, 18:37

Sonntag 16. Oktober 2005, 17:40

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

Sonntag 16. Oktober 2005, 18:29

was heißt du dokumentierst im docstring.
kannste mir das mal erklären oder ein beispiel geben
Leonidas
Administrator
Beiträge: 16024
Registriert: Freitag 20. Juni 2003, 16:30
Kontaktdaten:

Sonntag 16. Oktober 2005, 19:28

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.
My god, it's full of CARs! | Leonidasvoice vs Modvoice
ProgChild
User
Beiträge: 210
Registriert: Samstag 9. April 2005, 10:58
Kontaktdaten:

Sonntag 16. Oktober 2005, 19:54

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

Alles nachzulesen hier.
Leonidas
Administrator
Beiträge: 16024
Registriert: Freitag 20. Juni 2003, 16:30
Kontaktdaten:

Sonntag 16. Oktober 2005, 20:15

Ich denke nicht, dass man zum Dokumentieren LaTeX nutzen sollte. Da wären docutils denke ich, schon besser.
My god, it's full of CARs! | Leonidasvoice vs Modvoice
newbe

Montag 17. Oktober 2005, 18:07

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.
Antworten