Automatische 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
iceman21
User
Beiträge: 41
Registriert: Sonntag 25. März 2007, 20:45
Kontaktdaten:

Donnerstag 11. September 2008, 14:41

Hallo

Ich bin gerade dabei ein Projekt in Python anzufangen. Ich wollte Eclipse benutzen und durch Kommentare das einmal im Quellcode dokumentieren und zusätzlich glaube ich gibt es Tools oder so womit man die Documentation von dem Quellcode trennen kann. Habt ihr erfahrungen damit? Was sollte man da benutzen?

MfG
auser
User
Beiträge: 16
Registriert: Samstag 31. Mai 2008, 17:57

Donnerstag 11. September 2008, 15:25

warum schreibst du die Kommentare nicht direkt in Quelltext?
beim parsen und optimieren werden die sowiso alle rausgeschmissen.
Leonidas
Administrator
Beiträge: 16024
Registriert: Freitag 20. Juni 2003, 16:30
Kontaktdaten:

Donnerstag 11. September 2008, 15:28

iceman21 hat geschrieben:Ich wollte Eclipse benutzen und durch Kommentare das einmal im Quellcode dokumentieren und zusätzlich glaube ich gibt es Tools oder so womit man die Documentation von dem Quellcode trennen kann.
Meinst du wie pydoc/epydoc (JavaDoc) oder eher stand-alone Dokumentation wie mit Sphinx (Python-Docs)?
My god, it's full of CARs! | Leonidasvoice vs Modvoice
Benutzeravatar
snafu
User
Beiträge: 5536
Registriert: Donnerstag 21. Februar 2008, 17:31
Wohnort: Gelsenkirchen

Donnerstag 11. September 2008, 15:55

Statt Kommentaren lieber Docstrings nutzen, sofern du das nicht meintest.

Code: Alles auswählen

def greet(somebody):
    '''greet(somebody)
        
    This function sends out greetings to somebody. :-)
    '''
    return 'Hello %s.' % somebody

Code: Alles auswählen

>>> import testmod
>>> print testmod.greet.__doc__
greet(somebody)
        
    This function sends out greetings to somebody. :-)
    
>>> print testmod.greet('snafu')
Hello snafu.
Leonidas
Administrator
Beiträge: 16024
Registriert: Freitag 20. Juni 2003, 16:30
Kontaktdaten:

Donnerstag 11. September 2008, 16:58

Eigentlich nutzt man ja im Interpreter eher ``help()`` als direkt auf ``__doc__`` zuzugreifen.
My god, it's full of CARs! | Leonidasvoice vs Modvoice
Y0Gi
User
Beiträge: 1454
Registriert: Freitag 22. September 2006, 23:05
Wohnort: ja

Freitag 12. September 2008, 14:30

Und für Docstrings verwendet man doppelte Anführungszeichen (nach PEP 8). Einfache sehen für mich und je nach Code-Darstellung teilweise wie Pixelfehler aus ...
Antworten