Code-Dokumentation
Commit-Messages
Jeder Commit muss mit einem Azure DevOps-Ticket verknüpft und mit einer aussagekräftigen Nachricht versehen sein.
Format: #<TicketNr> <Beschreibung>
Gute Commit-Messages schreiben
Orientierung bietet der Leitfaden How to Write a Git Commit Message.
Kommentare im Code
| Regel | Beschreibung |
|---|---|
| Sprache | Kommentare werden auf Englisch verfasst |
| Sinnvoll kommentieren | Nur dort kommentieren, wo der Code allein nicht selbsterklärend ist |
| Keine Kommentarblöcke | Keine Doku-Trigger, Kommentarblöcke oder Markierungen wie // TSO BEGIN / // TSO END |
Funktionsdokumentation
Öffentliche Funktionen und Schnittstellen werden im XML-Documentation-Comment-Stil dokumentiert. Die Dokumentation beantwortet zwei zentrale Fragen:
- Was macht die Funktion?
- Wie ist sie zu verwenden?
Wenn der Funktionsname bereits selbsterklärend ist, kann auf eine zusätzliche Beschreibung verzichtet werden. Bei komplexerer Logik oder nicht-offensichtlichem Verhalten ist eine ergänzende Dokumentation jedoch Pflicht.
Erweiterbarkeit
Code ist grundsätzlich erweiterbar zu programmieren, sodass andere Extensions darauf aufbauen können (z. B. durch Events oder Interfaces).