Was sind die schlimmsten Kommentare?

Am schlimmsten finde ich, wenn alle drei Zeilen das kommentiert wird, was sowieso im Code steht und wenn das dann auch noch nummeriert ist.

//1. load the file
bool success = loadFile()

//2. Check if loaded
if( success )
...
//3.
...
//4.
...
//5.
.....
//9. Finish

Wenn ich da was einfügen muss, denke ich mir nur: Du willst doch jetzt nicht ernsthaft, dass ich die blöden Zahlen anpasse.

Rhombicosidodecahedron

Die Idee ist genial

Wenn ich da was einfügen muss, denke ich mir nur: Du willst doch jetzt nicht ernsthaft, dass ich die blöden Zahlen anpasse.
Und deswegen gibt es die reelen Zahlen:

// 3,1415926535. rufe diese oder jene Funktion auf

Außerdem kannst du Zahlen als Komplexe Zahlen

// 2 + 3i. Lade die Instruktionen aus dem Speicher

oder Tupel im Form von

// (7, -3). Inkremetiere einen Pointer

verwenden um den Revisionsstand abzuspeichern den du an genau jenem Punkt hast.

Jochen Kalmbach

BUGBUG
http://blogs.msdn.com/b/larryosterman/archive/2005/03/29/403439.aspx

Wer mal die Chance hatte in den (alten) Windows Source Code reinzuschauen, der wurde da oft fündig

hustbaer

Am schlimmsten finde ich Kommentare die nicht zum Code passen.
Also ein Kommentar das sagt "hier passiert jetzt ...", und in Wirklichkeit passiert was anderes.

Oft ist es so dass das was das Kommentar sagt das ist was passieren sollte, und der Code einfach nur fehlerhaft ist. Und manchmal ist der Code fehlerhaft, aber irgendwelche anderen Programmteile hängen von diesem Fehler ab, so dass man ihn gar nicht mehr fixen "darf". Manchmal wurde aber auch vergessen das Kommentar anzupassen nach dem der Code (absichtlich) geändert wurde.

Auf jeden Fall weiss man dann nie was Sache ist. Kann/soll man den offensichtlichen Fehler fixen?

Genau so schlimm ist das Fehlen von Kommentaren an Stellen, die wie ein Fehler aussehen, aber kein Fehler sind (aber um fehlende Kommentare geht's ja hier nicht).

Die schon erwähnten "stating the obvious" Kommentare finde ich auch schlimm. Ganz besonders lustig, wenn quasi jede Zeile Code erklärt wird, aber die ganze Programmstruktur/Namen/... so schlimm sind, dass man keine Ahnung hat was das Programm eigentlich macht.

knivil

Falsche Kommentare!

Catch (Exception e) { 
 //who cares? 
}

*rant*

JavaScript, Dynamics CRM:

// Waehrung
    if (crmInst.all.____transactioncurrencyid.DataValue == null) {
        var lookupData = new Array();
        var lookupItem = new Object();      //Set the id, typename, and name properties to the object.
        lookupItem.id = 'F1248999-88F7-4759-827A-781686E35FAD';
        lookupItem.typename = 'transactioncurrency';
        lookupData[0] = lookupItem;      // Set the value of the lookup field to the value of the array.
        crmInst.all.____transactioncurrencyid.DataValue = lookupData;
    }

Was bringt hier ein solcher Kommentar? Man weiss ja trotzdem nicht, was genau gemacht wird. Sehr schön, ich liebe Guids. Danke Microsoft

hustbaer schrieb:

Am schlimmsten finde ich Kommentare die nicht zum Code passen.

knivil schrieb:

Falsche Kommentare!

Hell, yeah! Das ist das allerschlimmste. Deshalb auch Nummer 1 in:
http://mindprod.com/jgloss/unmaindocumentation.html

abc.w

/rant/ schrieb:

... ____transactioncurrencyid ... ____transactioncurrencyid

Marthog

Die Kommentare bei den Skripten des PCspiels Gothic sind genial.

//Finer weg von der Formel! Ich weiß genau, was ich tue!

//Fehler verbessert   //Das war schon richtig so

Und bei einem magischen Amulett:

//Was soll das denn machen? Dämonen beschwören

freaky

Marthog schrieb:

Die Kommentare bei den Skripten des PCspiels Gothic sind genial.
//Finer weg von der Formel! Ich weiß genau, was ich tue!
//Fehler verbessert   //Das war schon richtig so
Und bei einem magischen Amulett:
//Was soll das denn machen? Dämonen beschwören

Hehe, darf ich fragen woher du genau das hast? Gibt es damit eine Seite oder so? Als Gothic-Fan würde ich mir das mal gerne anschauen