Das deutsche Python-Forum

Mein PyLucid Ding ist nun schon ziemlich gewachsen... Nun möchte ich gern, um den Überblick zu bewahren, etwas Dokumentieren...
z.B. wie die Zusammenhänge zwischen Modul/Klasse XY mit Modul/Klasse X sind; Aufbau der Datenbank; Funktion des ModulManagers usw.

Hab mir FreeMind angeschaut, aber ich weiß nicht ob ein MindMap dafür taugt... Ich glaub da kann man schwer Abläufe festhalten...

Was benutzt ihr denn so?

Hi,

ich benutze für solche dinge Verschiedene Ansätze.

Zum einen CVS als Versionsverwaltung, UML zum Modellieren (Klassendiagramme, Sequenzediagramme usw.) und das gute alte Textfile (bzw. heutzutage OpenOffice) zum Dokumentieren.

Mindmaps sind zum organisieren von Ideen ganz nett, aber für eine solche Dokumentation finde ich nicht zu gebrauchen.

P.S: Wenn man CVS nutzt und sehr Atomar eincheckt (Sprich jede kleine Änderung direkt einchecken, sobald diese halbwegs funktioniert), hat man es sehr leicht die Doku immer schön auf Vordermann zu bringen. (Natürlich nur, wenn man auch beschreibt was man getan hat [mit CVS])

Was kannst du für UML empfehlen???

Ich benutze Docstrings recht ausgiebig und dann epydoc um HTML-Dokumentation draus generieren zu lassen. Und für sonstige Texte finde ich ReStructuredText (ReST) sehr gut. Das ist reiner Text mit recht "unauffälligen" Auszeichnungen um HTML und PDF (via (pdf)LaTeX) daraus zu generieren.

UML habe ich bei Python bis jetzt noch nicht benötigt, weil die Klassenhierarchien nicht so ausufern müssen wie zum Beispiel bei Java. Da hat mir bisher immer der Klassenhierarchie-Baum in der epydoc-Dokumentation ausgereicht.

Wenn ich UML erzeuge dann entweder mit Dia (auch unter Windows zu haben) oder Umbrello.

Dia ist ein guter Tip...

Aber eigentlich hast du schon recht, am besten man Dokumentiert das meiste direkt im Source-Code...
Ich habe nir auch epydoc angeschaut, bekomme aber ehr unbefriedigende Ergebnisse. Ich denke es liegt daran, das PyLucid kein echtes Python-Pakages ist. Es ist halt "nur" ein CGI-Programm...

Ich mir auch nochmal den alten Thread quellcode ordentlich dokumentieren angeschaut und mit pydoc probiert... Aber auch das ist nicht ganz das optimale...

Hier ist der Link zu Dia: http://www.gnome.org/projects/dia/
Und für Windows: http://dia-installer.sourceforge.net/

Ich wollte es gerade mal wieder nutzten und musste erst googlen, bis ich die Homepage gefunden hatte

BlackJack hat geschrieben:Ich benutze Docstrings recht ausgiebig und dann epydoc um HTML-Dokumentation draus generieren zu lassen. Und für sonstige Texte finde ich ReStructuredText (ReST) sehr gut. Das ist reiner Text mit recht "unauffälligen" Auszeichnungen um HTML und PDF (via (pdf)LaTeX) daraus zu generieren.

Sorry wegen kurzen OT :/

Du nutzt ja auch epydoc. Da hätte ich ne frage: Benutzt du den ganzen Epytext Markup kram wie B{}, L{}, usw. oder lässt du das weg? Mir wurde gesagt das wenn man sich das mit der Konsole oder mit pydoc anschaut, sehe das sehr blöd aus weil damit zuviel "noise" in den docstrings sind. Aber gerade L{} finde ich sehr praktisch um Links, ineerhalb von Funktionen/Methoden, zu anderen Funktionen/Methoden/Klassen zu setzen.

Wie siehst du das und wie hältst du das mit den Epytext Markup?

lg

Ich benutze ReST auch in `epydoc`.

BlackJack hat geschrieben:Ich benutze ReST auch in `epydoc`.

Wir (Team Pocoo) auch, und wir fahren damit sehr gut.

Ich benutze ReST auch in `epydoc`.

Hi!

Epydoc mit reSt ist einfach super!

lg
Gerold

Wie realisiert man den Verknüpfungen auf Methoden mit epydoc Man kann ja nur auf URLs verknüpfen? Oder ist das nicht benötigter Luxus? ^^

lg

XtraNine hat geschrieben:Wie realisiert man den Verknüpfungen auf Methoden mit epydoc Man kann ja nur auf URLs verknüpfen? Oder ist das nicht benötigter Luxus? ^^

`YourObject`

thx.

lg