Inline Kommentare und Dokumentation

Inline Kommentare sind neben aussagekräftigen Subversion commits essentiell für das lange Überleben einer Software. Wenn Sie jahrelang an einem Produkt arbeiten ist es unmöglich dass Sie ohne Kommentare noch immer wissen was der Code den Sie vor zwei Jahren implementiert haben macht.

Zur effizienten und effektiven Webprogrammierung gehört daher auch eine gewisse Konzentration von Kommentare pro Codezeilen. Wenn du jedoch gewisse Coding Standards einhaltest, deinen Funktionen aussagekräftige Namen gibst und alle Werte zuerst Variablen zuweist die auch etwas aussagen, dann kannst du dir die meisten Kommentare ersparen.

comments.jpg