Python Dokumentation

[DEvent]

Hi,
wie sieht das in Python mit der Dokumentation des Quellcodes aus? In Java habe ich ja genau definierte Kommentare fuer Javadoc:

class Foo {

    /**
    * Method foo, do this and that.
    * @param a some nice number.
    * @param bar an instance of the same class.
    * @return some calculated number.
    */
    int methodFoo(int a, Foo bar) {
    }
}

Da gibts ja in Python diese "Documentation Strings". Aber wie kann man return-Wert und Parameter dokumentieren? Wie machen also die Python-Benutzer hier?

[Guidoman]

Man kann alles.
Ich würde zu doxygen raten. Das funktioniert mit python docstrings und hat in etwa die gleichen Möglichkeiten wie javadoc.

[so]

http://www.stack.nl/~dimitri/doxygen/docblocks.html#pythonblocks
Ich nehm die ## variante

[DEvent]

Guidoman schrieb:

Man kann alles.
Ich würde zu doxygen raten. Das funktioniert mit python docstrings und hat in etwa die gleichen Möglichkeiten wie javadoc.

Doxygen kann leider die doc-strings nicht richtig verarbeiten. Siehe http://www.stack.nl/~dimitri/doxygen/docblocks.html#pythonblocks

Entweder ich benutze die doc-strings, kann dann das Python interne help() benutzen aber keine Doxygen special commands. Oder ich schreibe die Kommentare mit ## aber dann gibts kein Python-help().

Hab schon das Ausprobiert: http://i31www.ira.uka.de/~baas/pydoxy/
Aber das funktioniert auch nicht richtig. Es gibt zwar den Text in den doc-Strings aber keine Methodnamen mehr.

PS: Wie kann man Konstanten in Python definieren und dokumentieren? Also Z.B.:

class Foo:
    MAX = 5

Wie kann ich das jetzt dokumentieren mit den doc-strings?