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
}

[Namenloser]

Zitat von 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?!)

Der Code hat mich gleich an die Programmieren-Vorlesung hier erinnert... dann ist mir aufgefallen, dass du ja auch in Karlsruhe studierst

Als ich das erste (und letzte ) mal im Programmieren-Tutorium war und der Tutor uns zeigte, wie man jedes einzelne Klassenmember mit einem dreizeiligen Kommentar versehen soll, dachte ich erst, es wäre ein Scherz

Naja, aktuell mache ich hier dieses Softwarepraktikum (nicht am KIT), und da ist jetzt von den Coding Conventions gefordert, zwischen alle Funktionsdefinitionen solche Trennlinien zu machen:

//============================================================================

Auch sehr sinnlos... wobei der Rest recht vernünftig ist, das macht es für mich noch irritierender.

[Meflin]

Zitat von Namenloser:

Naja, aktuell mache ich hier dieses Softwarepraktikum (nicht am KIT), und da ist jetzt von den Coding Conventions gefordert, zwischen alle Funktionsdefinitionen solche Trennlinien zu machen:

//============================================================================

Wie dumm ist das denn? Vor allem, wenn man bedenkt, dass ein durchschnittlicher Editor sowas heutzutage von selbst einfügen anzeigen kann, sofern man es denn haben will

[Namenloser]

Ja, hab ich denen auch gesagt, dass ich das für eine Aufgabe des Syntax-Highlighting halte... aber was will man machen.