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
Automatische Dokumentation
-
- Python-Forum Veteran
- Beiträge: 16025
- Registriert: Freitag 20. Juni 2003, 16:30
- Kontaktdaten:
Meinst du wie pydoc/epydoc (JavaDoc) oder eher stand-alone Dokumentation wie mit Sphinx (Python-Docs)?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.
My god, it's full of CARs! | Leonidasvoice vs (former) Modvoice
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.