styleguide.md

Vereinbarungen zur Dokumentation

Für ein einheitliches Code- & Schriftbild legen wir folgendes fest.

Erläuternde Texte

Texte wie dieser sollten als Markdown verfasst werden. So sind sie einerseits ohne weitere Programme lesbar, andererseits, werden sie von GitHub komfortabel dargestellt. Für Programmierer eignet sich besonders der Markdown-Dialekt GitHub Flavored Markdown, der auch hier verwendet wird.

Code (Inline-Dokumentation)

Aus dem Protokoll vom 17.01.14 geht folgende Dokumentation hervor.

"""
Moeglicherweise mehrzeilige
ausfuehrliche Beschreibung

@param name typ beschreibung
@return name typ beschreibung
"""