API 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.
xturbo77
User
Beiträge: 39
Registriert: Montag 9. September 2002, 20:05
Kontaktdaten:

API Dokumentation

Beitragvon xturbo77 » 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 :wink: ?

EDIT: Nach etwas stöbern habe ich noch etwas nettes gefunden: http://epydoc.sourceforge.net/stdlib/
Voges
User
Beiträge: 564
Registriert: Dienstag 6. August 2002, 14:52
Wohnort: Region Hannover

Re: API Dokumentation

Beitragvon Voges » Donnerstag 21. August 2003, 13:48

Hallo!
xturbo77 hat geschrieben:Also ich finde da hat Java weit die Nase vorne. Was meint ihr dazu, hat Python hier noch Nachholbedarf,
Die Sun-Leute verdienen auch ihr Geld damit. Da kann man erwarten, dass die ordentliche Arbeit leisten. Bei 'Feierabendprogrammiersprachenentwicklern' bin ich da schon nachsichtiger.
xturbo77 hat geschrieben:oder seid ihr alles solche Pythongurus die alle Module in- und auswendig kennen :wink: ?
Ich guck i.d.R. in die Doku meiner Python-Installation (da ist pickle recht gut dokumentiert), dann in meine Bücher (z.B. Nutshell) und ab dann wird gegoogelt ;-)
Jan

Wer ist online?

Mitglieder in diesem Forum: Bing [Bot]