Einzelnen Beitrag anzeigen

Elvis

Registriert seit: 25. Nov 2005
Ort: München
1.909 Beiträge
 
Delphi 2010 Professional
 
#20

Re: Programm richtig kommentieren

  Alt 8. Okt 2006, 22:46
Zitat von Kevin:
Richtig oder falsch kommentieren ist auf jeden Fall auch relativ. Und wer jemals einen Quellcode von jemand anderem weiterentwickeln "musste", ist für jeden noch so kleinen Kommentar dankbar.
Kommt immer darauf an wieviel 3rd-Party Libs oder selbstgeschriebene funktionen im Spiel sind.
In Luckies Beispiel wird eine Funktion zum Konkatinieren zweier Strings benutzt, die auch noch die resultierende Länge zurückgibt.
Sie wurde a)nur nichtssagend "func1" genannt und b) 2-mal mit komplett unterschiedlichen Absichten benutzt. Einmal um die Länge zu bekommen, ein anderes mal um tatsächlich mit den Strings zu arbeiten.
Sowas ist schon vom Prinzip her etwas schief und erfordert deshalb Kommentare.
Code, der keine Fallstricke hat braucht keine Kommentare, da dadurch die schnelle Lesbarkeit einfach sinkt.
Aber Methoden selbst sollten immer eine Summary im Header haben, zumindest wenn sie nix triviales machen.

Nachtrag:@Hagen, jennau!
Robert Giesecke
I’m a great believer in “Occam’s Razor,” the principle which says:
“If you say something complicated, I’ll slit your throat.”
  Mit Zitat antworten Zitat