Wartbarkeit eures Code

... ist zweifellos kein beliebtes Thema, aber notwendig!

Natürlich gibt es immer Besseres und Spannenderes zu tun, als Codekommentare zu erstellen. Und selbst wenn euren Code nach dem Projekt niemand mehr anschauen muss, bereits im zweiten Sprint werdet ihr merken, dass ihr euch nicht mehr an alles erinnern könnt, schon gar nicht an Implementierungen anderer Teammitglieder. Kommentare ermöglichen häufig erst eine Weiterentwicklung und Wartbarkeit von Software. Im Folgenden werden einige "good practise" Hinweise gegeben.

Kommentare

• Wann immer ihr Code schreibt, verseht ihn direkt zu Beginn mit einem Minimum an Kommentaren.
• Wenn ihr eine Methode schreibt, reicht bereits ein kurzer Kommentar dazu, welchem Zweck die Methode dient und was sie tut, um die Lesbarkeit eures Code zu steigern.
• Man muss sich dann z.B. bei spätereren Bugfixes weniger Zusammenhänge durch langes Suchen und Lesen selbst aus dem Code erschließen.
• Solche Kommentare kann man auch schon schreiben, BEVOR man die Methode selbst implementiert.
• Das kann sogar bei der Implementierung hilfreich sein (Zeitersparnis!), weil die Aufgabe einer Methode vorher klarer definiert wird.

Aufgabe

Denkt bei der Entwicklung daran, wann immer ihr codet, auch zu kommentieren.