API Dokumentation
Verfasst: Donnerstag 21. August 2003, 10:13
Wie dokumentiert ihr eure Programme? Benutzt ihr DocStrings oder einfach Kommentarzeilen, oder ähnliches?
Erzeugt ihr eine html Dokumentation? Hierfür gibt es ja schon eine Menge Tools, ich kenne HappyDoc und pydoc, wobei mir das Ergebnis von pydoc mehr zusagt.
Aber eines nervt mich ganz gewaltig: Die meistens Dokus enthalten keine Information über Typen/Klassen der Paramater und der Rückgabewerte. Vielleicht bin ich in der Hinsicht ja zu javadoc verwöhnt (mit einem guten Javadoc ist es fast schon ein Kinderspiel fremden Code zu nutzen), da ist alles klar strukturiert.
Sehr gut dokumentiert ist die string klasse (siehe http://web.pydoc.org/2.2/string.html). Da sieht man wenigstens was die Funktionen zurückgeben.
Negativbeispiel, das Modul pickle: http://web.pydoc.org/2.2/pickle.html
Also ich finde da hat Java weit die Nase vorne. Was meint ihr dazu, hat Python hier noch Nachholbedarf, oder seid ihr alles solche Pythongurus die alle Module in- und auswendig kennen ?
EDIT: Nach etwas stöbern habe ich noch etwas nettes gefunden: http://epydoc.sourceforge.net/stdlib/
Erzeugt ihr eine html Dokumentation? Hierfür gibt es ja schon eine Menge Tools, ich kenne HappyDoc und pydoc, wobei mir das Ergebnis von pydoc mehr zusagt.
Aber eines nervt mich ganz gewaltig: Die meistens Dokus enthalten keine Information über Typen/Klassen der Paramater und der Rückgabewerte. Vielleicht bin ich in der Hinsicht ja zu javadoc verwöhnt (mit einem guten Javadoc ist es fast schon ein Kinderspiel fremden Code zu nutzen), da ist alles klar strukturiert.
Sehr gut dokumentiert ist die string klasse (siehe http://web.pydoc.org/2.2/string.html). Da sieht man wenigstens was die Funktionen zurückgeben.
Negativbeispiel, das Modul pickle: http://web.pydoc.org/2.2/pickle.html
Also ich finde da hat Java weit die Nase vorne. Was meint ihr dazu, hat Python hier noch Nachholbedarf, oder seid ihr alles solche Pythongurus die alle Module in- und auswendig kennen ?
EDIT: Nach etwas stöbern habe ich noch etwas nettes gefunden: http://epydoc.sourceforge.net/stdlib/