Seite 1 von 1
Automatische Dokumentation
Verfasst: Donnerstag 11. September 2008, 14:41
von iceman21
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
Verfasst: Donnerstag 11. September 2008, 15:25
von auser
warum schreibst du die Kommentare nicht direkt in Quelltext?
beim parsen und optimieren werden die sowiso alle rausgeschmissen.
Re: Automatische Dokumentation
Verfasst: Donnerstag 11. September 2008, 15:28
von Leonidas
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)?
Verfasst: Donnerstag 11. September 2008, 15:55
von snafu
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.
Verfasst: Donnerstag 11. September 2008, 16:58
von Leonidas
Eigentlich nutzt man ja im Interpreter eher ``help()`` als direkt auf ``__doc__`` zuzugreifen.
Verfasst: Freitag 12. September 2008, 14:30
von Y0Gi
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 ...