Code dokumentieren

Jede Datei muss eine kurze einheitliche Dokumentation enthalten mit mindestens: Projektname, Dateiname, Autor(en). In allen Dateien müssen ganz oben alle Team-Mitglieder aufgelistet werden! Auf die Dokumentation der einzelnen Funktionen sein hier verzichtet. Nutzen sie aber inline-Kommentare. Oben in jeder Datei muss eine Änderungshistorie gepflegt werden. Dabei ist folgendes einzutragen: Wann wurde geändert? Von wem wurde geändert? Was würde geändert? (Sinnvoll ist auch die Angabe: Warum wurde etwas geändert – das ist aber hier kein Muss.) Nutzen sie dabei das doxygen-Schlüsselwort „\version“. Beispiel:

/*! \file main.cpp

• Ein Satz zur Datei…
• \author Mustermann, Anna (AM)
• \version 2023-07-31 (AM)
• Zustandsautomat um Logik für Accel eingefuegt.
• \version 2023-08-01 (AM)
• Accel korrigiert, weil bei ‘e‘ fehlerhaft. */

ALTERNATIV: Sie trage nur den Dateinamen oben ein und nutzen ansonsten gitlab zur Versionierung. Dort tragen sie sinnvolle commit-messages ein. (Konkretes Minimum: Es müssen auf die Dateien verteilt insgesamt mindestens 9 commits mit nennenswerten Änderungen und Kommentaren sein.)

Scrum-Bemerkung: In der Sprache von Scrum gehört so eine Qualitäts-Anforderung zur sogenannten "Definition of Done"....neben der jeweiligen Funktionalität, die natürlich umgesetzt sein muss UND (im echten Leben) auch systematisch getest sein muss. Nur dann kann die Entwicklung am Ende eines Sprints akzeptiert werden.