Zum Hauptinhalt springen

Projekt dokumentieren

Mini-README​

# Projektname
Was macht es?
Wie startet man es?
Welche Tasten/Menuepunkte gibt es?
Welche Klassen gibt es?
Bekannte Einschraenkungen

Kommentare im Code​

# Hauptschleife: Menue bis Exit

Nicht jede Zeile kommentieren – die kniffligen Stellen.

Rate mal!​

Reichen 0 Sätze Doku?

Auflösung

Für dich in einer Woche oft nein. Kurz schreiben hilft.

Übungen​

Level 1​

5-Zeilen-README.

Level 2​

Klassenliste erklären.

Level 3​

Screenshot/Notiz der Demo-Schritte.

Mini-Quiz​

Mini-QuizWas gehoert in die Doku?