Äh, ich lese gerade, daß ich den Code kommentieren muß.
Wenn ich mir das vorhandene Beispiel ansehe, sieht der Kommentar irgendwie blöde aus:

c = a & b; //Der Ausgang c wird durch ein UND von a und b berechnet

Der Kommentar beschreibt ja nicht anderes als das, was schon im Code drinsteht. Soll ich jetzt zum Beispiel (hoffentlich reißt mir jetzt keiner den Kopf ab wegen des postens von Lösungen) schreiben:

HA(a,b,t1,t2); // Berechne Summe von a und b mit einem HA, t2=sum und t1=carry
carrout = t1|t3; // das carryout wird durch ein ODEr von t1 und t3 berechnet

Ich finde das irgendwie blöd.

Benjamin.

Hi

Der Sinn der Kommentare ist es nicht, tiefschürfende Monologe zu verfassen, sondern den Tutoren die Korrektur zu erleichtern bzw. teilweise erst zu ermöglichen. Das gilt insbesondere für die Fällen, in denen die Lösung unvollständig, falsch, oder (am allerschlimmsten) total verquer, aber richtig ist; ohne Kommentare ist es bei Programmieraufgaben teils nicht einmal möglich herauszufinden, was der Abgebende mit seinem Code erreichen wollte.

Du magst es blöd finden, aber die Tutoren freuen sich über Kommentare so wie Du sie oben beispielhaft angegeben hast.

Grüße
Tobias Nopper



Edited 1 time(s). Last edit at 05/02/2005 10:14AM by nopper.

Es ging mir ja auch nicht darum, den Sinn von Kommentaren im Allgemeinen in Frage zu stellen (so wie es vielleicht rübergekommen sein mag).

Mir ging es einfach nur darum, daß ich Kommentare, die /exakt/ das beschreiben, was im Code vorher drinsteht, für überflüssig halte.

Naja, sei es drum.

Benjamin.