• Als Spam markieren
• Beitrag melden

• 
  Diese Gruppe Alles

• Archiv
• RSS-Feeds

• Kontakt
• Hilfe
• Impressum
• Datenschutz

Code-Dokumentation

Hallo,

auch diese Frage ist vermutlich trivial und 1000x beantwortet; aber
zumindest in meinem Buch (Nutshell) auf der Python-Doku-Seite habe ich
nichts gefunden: Wie dokumentiere ich sinnvollerweise den Code (API)?

Soweit bin ich:

class MyClass:
"""Kurzbeschreibung der Klasse.

Langbeschreibung.

Class Attributes:
a1 -- erstes Attribut (vom Typ xyz)

Object Attributes:
a2 -- zweites Attribut (vom Typ def)

"""
def my_func(x):
"""Kurzbeschreibung.

Langbeschreibung.

Parameters:
x -- ein Parameter (vom Typ xxx)

Return:
etwas vom Typ yyy

"""

Ich vermute aber, dass es für all diese Punkte (Attribute, Parameter,
Rückgabewerte, Typen) formalere Beschreibungen gibt, die z.B. auch
automatisiert testbar sind, und dass auch die Ãœberschriften einem
gewissen Standard genügen.

Viele Grüße

Ole

Antworten