Eure besten Quellcode Kommentare...

[Valle]

Kommentare können durchaus äußerst sinnlos werden.

An meiner Uni gibt es bei der Abgabe der Aufgaben zur Programmieren-Vorlesung eine automatische Überprüfung auf Stil und Kommentierung. Das endet dann in solchen Stilblüten, damit der Automat fehlerfrei durchläuft:

(Dabei sei hervorgehoben, dass nicht nur die Kommentierung jedes einzelnen Enum-Elements sinnlos ist, sondern auch diese inline-Versionierung und Angabe des Autors. Was um Himmels Willen soll der Quatsch denn?!)

Code:

/**
 * Eine einfache Definition eines Wochentags.
 * @version 1.0
 * @author Valentin Voigt
 */

enum Weekday {
   
   /**
    * Sonntag   
    */
   
   SUNDAY,
   
   /**
    * Montag
    */
   
   MONDAY,
   
   /**
    * Dienstag
    */
   
   TUESDAY,
   
   /**
    * Mittwoch
    */
   
   WEDNESDAY,
   
   /**
    * Donnerstag
    */
   
   THURSDAY,
   
   /**
    * Freitag
    */
   
   FRIDAY,
   
   /**
    * Samstag
    */
   
   SATURDAY
}