Wissen von IT Mitarbeitern

[Andreas Pflug]

Gerade diejenigen, die sich in fremden Code einfuchsen sollen (auch gerne weniger sachkundige Menschen) profitieren von kommentiertem Code. Es sei denn Du willst Dir Herrschaftswissen sichern...

Man sollte aber aufpassen, dass man Kommentare im Stil von

i += 1;  // erhoehe i um 1

vermeidet, da sie den Überblick eher behindern.

In den Zeilen

[...]
 { // View[0]-Objekt
      DIS_NA : "Germany",  // View[0].DIS_NA-Eigenschaft
 [...]

sehe ich den ersten Kommentar gerade noch ein (um weniger erfahrenen Leuten klarzumachen, dass die Liste bei 0 und nicht bei 1 anfängt). Der zweite Kommentar erscheint mir etwas viel des Guten...

Schön finde ich es immer, wenn Kommentare vor dem Anfang einer Funktion kurz beschreiben, welcher Algorithmus verwendet wird und evtl. sogar eine Literaturreferenz (falls es sich um einen komplexeren Algorithmus handelt) geben.

MfG

Andreas