Wie "property" für API Dokumentation dokumentieren

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.
Antworten
CM
User
Beiträge: 2464
Registriert: Sonntag 29. August 2004, 19:47
Kontaktdaten:

Samstag 27. Oktober 2007, 21:24

Hoi,

wie macht man in einer API-Doku am besten deutlich, daß eine best. Methode einer Klasse eigentlich eine "property" ist?
Gegenwärtig habe ich z. B. diesen Docstring:

Code: Alles auswählen

    @property
    def rg(self):
        """
            property:
            radius of gyration 
        """
        ...
Ist, wenn man das z. B. durch epydoc nudelt, dann allen klar, um was es sich hier handelt? Das man es mit instance.rg erhalten kann? Oder gibt es bessere Konventionen?

Danke,
Christian
BlackJack

Samstag 27. Oktober 2007, 22:48

Bei Epydoc ist es klar, weil das properties erkennt und in einem eigenen Abschnitt aufführt.
CM
User
Beiträge: 2464
Registriert: Sonntag 29. August 2004, 19:47
Kontaktdaten:

Samstag 27. Oktober 2007, 22:54

Also ich habe Epydoc Version 3.0beta1 mit --latex aufgerufen und da kann ich weder eine gesonderte Sektion noch irgendeine andere Makierung erkennen, wenn epydoc ein property trifft.

Gruß,
Christian
Antworten