Hier im Forum: Lange Zeilen nicht lesbar

[Der Martin]

Hallo Rolf,

Mein Anspruch ist, dass dann der Kommentarbereich so ausführlich "bestückt" ist, dass man dort den Programmablauf und die Gedanken dazu im Klartext mitlesen kann.

Du meinst aber hoffentlich nicht sowas:

   let j = first_j;                           // Beginne bei first_j
   for (let i=0; i<10; i++) {                 // Laufe mit i von 0-9
                                     
      document                                // Text von foo_(i) auf "Nr. j" setzen
         .getElementById("foo_" + i)
         .textContent = "Nr. " + j;

      j = j + 1;                              // nächstes j
   }                                          // Ende for-i

nein, das ist weitgehend sinnfrei. Der Kommentar soll den Zweck der Anweisung beschreiben - also das, was der Programmierer sich dabei gedacht hat.
Ein Kommentar wie "i auf Startwert 0 setzen" ist nutzlos. Das sieht man auch schon am Code.

Eigentlich gilt: Das "was" am Code sollte selbsterklärend sein. Code, für den man Kommentare braucht, um zu verstehen, was er tut, ruft nach Überarbeitung. Das "warum" ist eine andere Sache. Das darf man gerne seinem 4 Monate älteren Ich erläutern.

Genau das meinte ich. Wenn ich ein Stück C-Code nach drei Jahren wieder in die Hand nehme und überarbeiten will, dann müssen die Kommentare gut genug sein, dass ich mich in wenigen Minuten wieder zurechtfinde. Im Idealfall sogar jemand anders, der den Code übernehmen will/muss.

Ciao,
 Martin