Eure besten Quellcode Kommentare...

[Tonic1024]

Zitat von r2c2:

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

Das ist reine Theorie.

Wenn man zum Beispiel einem Webserver einige Aufgaben gibt, so steht der Code im Indys OnCommandGet Routine. Wenn man jetzt hin geht und die individuelle Parameter Detektion in eine Funktion auslagert und jede einzelne Aufgabe in eine separate Funktion auslagert braucht man dennoch die selben 10 Zeilen (okay, sehr ähnliche 10 Zeilen) im Code wieder und wieder und wieder untereinander. Ein fürs Auge leicht wieder zu findender grüner "Eyecatcher" ist beim scrollen sehr hilfreich. Die Länge der Methode ist damit, unabhängig davon ob man ein Buch gelesen hat oder nicht, direkt abhängig vom Funktionsumfang des Servers. Nur mal ein Beispiel.

Oder ein Gegensätzliches. Wenn man komplexe aber dennoch überschaubare Aufgaben (z.B. Stream empfangen, manipulieren und weiterleiten) solange in separate Routinen aufteilt bis kaum noch ersichtlich ist welche Nebenwirkungen eine Änderung in einer Sub-Sub-Routine hätte ist das auch nicht besonders übersichtlich.

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.