epydoc: komplexe Parametertypen
Von: Ole Streicher (ole-usenet-spam@gmx.net) [Profil]
Datum: 28.09.2009 12:06
Message-ID: <ytz1vlrfkoi.fsf@news.ole.ath.cx>
Newsgroup: de.comp.lang.python
Datum: 28.09.2009 12:06
Message-ID: <ytz1vlrfkoi.fsf@news.ole.ath.cx>
Newsgroup: de.comp.lang.python
Hallo, ich habe mich bei der Code-Dokumentation für Epydoc entschieden und stehe jetzt vor folgendem Problem: Ich habe viele Parameter, Attribute usw. bzw. Rückgabewerte, die z.B. Listen von Objekten bestimmter Klassen sind. Wie schreibt man das am besten? Java-like wäre es :ivar data: ... :type data: numpy.ndarray<float> :ivar channel: ... :type channel: list<`Channel`> Wie wäre das Python-like? Und was muss ich dabei wie quoten, damit ich eine optimale Verlinkung der Parameter erhalte? Kann ich eigentlich auch auf die Dokumentation der Python-Builtins (float, list im Beispiel) und auf die externer Bibliotheken (numpy im Beispiel) verweisen? Wenn ja, wie? Viele Grüße Ole[ Auf dieses Posting antworten ]