Eure besten Quellcode Kommentare...

[Furtbichler]

Zitat von Tonic1024:

Zitat von r2c2:

Das ist ein Zeichen dafür, dass deine Methoden zu lang sind.

Das ist reine Theorie.

Eher das Ergebnis jahrelanger Erfahrung professioneller Programmierer auf der ganzen Welt.

Zitat:

Wenn man zum Beispiel einem Webserver einige Aufgaben gibt...

Dann ruft man die Methode einer Klasse auf.

Zitat:

Ich wundere mich warum hier so eine Abneigung gegen Kommentare mit optischem Charakter herrscht. Ich hab noch beigebracht bekommen über jede Routine einen Funktionsbeschreibung, Parameterdefinition, Precondition und Postcondition zu tippen.

Na ja, Optik... Wieso nicht gleich mit Blümchen ausschmücken. Public-Methoden einer API ja, sonst ist das imho überflüssig.

Lies mal 'Pragmatic Programmer' oder 'Clean Code'. Dann wirst Du vielleicht erkennen, das Kommentare, bis auf wenige Ausnahmen, schlecht sind und den Code auf Dauer unleserlich machen. Was heute noch ein korrekter Kommentar wird, ist morgen veraltet, weil -wupps wegen Zeitmangel- der Kommentar nicht angepasst wurde.

Ausnahmen sind z.B.: Gesetzliche Vorschriften, Quellenangaben, mathematische Formeln und API-Dokumentation (in Zeiten von Code Proposal und automatisch generierter Hilfe aus Methoden-Kommentaren durchaus akzeptabel).

Dessenungeachtet und schon 1000x gesagt: Wer seinen Code kommentieren muss, hat wohl schwer verständlichen Code. Wer Parameter beschreiben muss, hat wohl schlecht gewählte Parameterbezeichnungen.

Umgekehrt: Wer kleine Methoden schreibt, die genau eine Sache machen (die sich also ohne das Wort 'und' beschreiben lassen), dann hat man den Code durch sich selbst dokumentiert: Er ist also lesbar, automatisch leichter wartbar und -weil verständlich und einfach- auch robuster.

Aber klar, man kann auch 100 Zeilen lange Monster schreiben und glücklich werden, fragt sich nur, wie lange. Ich überlege schon bei 10 Zeilen, ob ich nicht refaktorisieren kann (und mach das meistens auch).

Aber hier gehts um lustige Quelltextkommentare, nicht um Codestil.