Eure besten Quellcode Kommentare...

[sonz]

Lustig hier ..ich wette ich hab Tonnen dummer Kommentare in meinem Code.
Ich such mal bei Gelegenheit.

ABER :

Zitat von Mr_G:

Btw.: Ich habe noch keinen Kommentar (auskommentierter Code ausgeschlossen) gesehen, der direkt zu einem Fehler führt

Ich schon,hatte ich in meiner Abschlussprüfung !
Fließband mit Stückgutzähler in 6502 Assembler auf einem ProCOM (6502 basierter Bastel-Rechner mit LCD Display)
*grübel*
Wie war das noch ...
Die vorbei laufenden Pakete wurden gezählt und als Zahl auf dem LCD Display ausgegeben.
Währenddessen konnte einen Taste gedrückt und eine Text angezeigt werden,ohne das die Zählung unterbrochen wurden.uuuhhhiii
Ich hatte vor dem Part mit der Ausgabe des Textes auf dem Display einen Kommentar gesetzt (sowas wie ";Ab hier Textausgabe"),per UCASM auf dem PC kompiliert und auf den ProCOM gespielt ..
Die Anzeige des Textes flackerte wie Wild.
Ich hab ich die letzte Stunde versucht dieses Flackern zu entfernen.
Irgendwann meinte dann einer der Prüfer zu mir,der sich meinen Code angesehen hatte und auch nicht wusste woran es liegen könnte "Entferne doch mal den Kommentar" ..nach dem wir beide ihn für Verrückt erklärt hatten,hab ich dann einfach mal gemacht.
Und zu unserer großen Verwunderung .. das Flackern war weg!

Ich denke das war nen Bug in Crossassambler (nicht hauen Frank M. ) aber in dem Fall hat nen Kommentar direkt zu nem Fehler geführt.

Bis denne,
Ingo

[himitsu]

Delphi-Quellcode:

Var
  Form1: TForm1;
  (*
  Buhaha Böse , Globale Variablen
  *)
  State: TState;
  ...
  ganz viel davon
  ...
  aktualIndex: Integer;
  GPen: Tpen;

Implementation

ich will jetzt nicht unbedingt den armen corpsman anschwärzen, aber das ist aus seinem wii_whiteboard-Projektchen

[Corpsman]

*g*

[quote]
ich will jetzt nicht unbedingt den armen corpsman anschwärzen, aber das ist aus seinem wii_whiteboard-Projektchen
[/qoute]

keine sorge ich fühle mich nicht angeschwärzt.

Ich wollte damit dem Leser klar sagen "Wehe du nutzt globale variablen" bzw. "ich weis das ich das eigentlich mit lokalen Variablen hätte machen sollen"

[implementation]

Aus einem Projekt, dass ich zum BWINF einschicken werde ...

Delphi-Quellcode:

   // Im Code sieht Egypt.Theben nunmal besser aus als TBuildLocation.Theben ;)
   // Blöd, dass man Klassen hier nicht als nicht-instanzierbar kennzeichnen kann ...
   // Nachher kommt noch einer auf die Idee, Egypt zu instanzieren, und dann
   // ist das Geschrei wieder groß, dass es keine instanzbezogenen Methoden gibt ...
   Egypt = class
      class function Theben: TBuildLocation;
      class function Luxor: TBuildLocation;
      class function Karnak: TKarnak;
   end;

Man weiß ja nie, auf was für dämliche Ideen andere, oder sogar man selbst mal kommen könnte

Edit:

Delphi-Quellcode:

// Speicherleck, wir wissen wo dein Auto stand,
// es hat gut gebrannt, es hat gut gebrannt!

Als Kommentar zu einem Destructor ...

[himitsu]

Kennt FPC denn kein class abstract ?

PS: Notfalls kann man es (zumindestens in Delphi) auch einfach als Record anlegen.

Delphi-Quellcode:

Egypt = class abstract
   class function Theben: TBuildLocation;
   class function Luxor: TBuildLocation;
   class function Karnak: TKarnak;
end; 

Egypt = record
   class function Theben: TBuildLocation;
   class function Luxor: TBuildLocation;
   class function Karnak: TKarnak;
end; 

// eventuell die Methoden auch noch als static deklarieren

@Topic: zum Glück schreib ich zuwenige Kommentare, denn sonst wären meine Codes voll mit Gefluche und sonstigen Gotteslästerungen.

[Namenloser]

[OT]
@implementation: An dieser blöden Aufgabe hab ich ewig gesessen und bin zu keinem performanten Ergebnis gekommen ('nen funktionierenden Lösungsweg hatte ich zwar, aber mit grottiger Laufzeitkomplexität - und es war NICHT Brute-Force, falls du das jetzt denkst...). Hab mich leider wieder viel zu lange daran aufgehalten und deshalb jetzt kaum noch Zeit für die restlichen Aufgaben -.-
Du musst mir nach dem Einsendeschluss unbedingt mal verraten, wie du die gelöst hast...
[/OT]

[implementation]

Zitat von himitsu:

Kennt FPC denn kein class abstract ?

PS: Notfalls kann man es (zumindestens in Delphi) auch einfach als Record anlegen.

Zumindest im Objfpc-Mode kennt der FPC 2.4.0 weder Class Abstract noch erweiterte Records.

Zitat von NamenLozer:

[OT]
@implementation: An dieser blöden Aufgabe hab ich ewig gesessen und bin zu keinem performanten Ergebnis gekommen ('nen funktionierenden Lösungsweg hatte ich zwar, aber mit grottiger Laufzeitkomplexität - und es war NICHT Brute-Force, falls du das jetzt denkst...). Hab mich leider wieder viel zu lange daran aufgehalten und deshalb jetzt kaum noch Zeit für die restlichen Aufgaben -.-
Du musst mir nach dem Einsendeschluss unbedingt mal verraten, wie du die gelöst hast...
[/OT]

Meins läuft momentan ganz gut, wenn ich einzelne Teile teste.
Aber im ganzen sind leider noch einige Bugs drin.
Mir hat vor allem Aufgabe 2 'ne Menge Zeit gekostet (ist immer noch nicht fertig ...)

... und das Transformationsprogramm für die Dokumentation
Ich hab' dafür extra ein XML-Format entworfen, das von dem
Programm zu HTML konvertiert wird:

XML-Code:

<root>
 <defs>
  <codeschema name="pas" label="Object Pascal-Code">
   <default bg="#FFFFFF" fg="#000000"/>
   <keyword bg="#FFFFFF" fg="#0000FF"/>
   <literal bg="#FFFFFF" fg="#AAAAAA"/>
   <number bg="#FFFFFF" fg="#FFAA00"/>
   <comment bg="#FFFFFF" fg="#008000"/>
   <directive bg="#FFFFFF" fg="#880000"/>
  </codeschema>
  ...
 </defs>
 <body>
  <section>
   <head>Überschrift</head>
   <sub>Unter-Überschrift</sub>
   <paragraph>Text</paragraph>
   <code schema="pas">
     Code ...
   </code>
  </section>
 </body>
</root>

Und für den Codeblock gibt's dann Syntax-Highlighting
Muhahaha, ist das nicht episch?

Ach ich red' schon wieder zu viel

[edit]Ist das XML-SynHiLi schrott?

[himitsu]

Delphi-Quellcode:

{;  ???  we really have to look for the first eof byte in the
; ???  last record and truncate the file there.
; Not very nice and clean...
;

Und dann gibt es noch andere Falsche-Meldungen:

Delphi-Quellcode:

TFileRec = packed record (* must match the size the compiler generates: 592 bytes *)
  ...
  {$IFNDEF UNICODE}
  Name: array[0..259] of AnsiChar;
  {$ELSE}
  Name: array[0..259] of WideChar;
  {$ENDIF}

Vonwegen "must"
Deswegen ging nun ein Code nicht mehr, weil man sich auf sowas verläßt.
Die Größe hatte sich also doch verändert und es ist nicht beim AnsiChar geblieben.

Und warum nicht einfach Char?

[himitsu]

Delphi-Quellcode:

{ *********************************************************************** }
{                                                                         }
{ Delphi DBX Framework                                                    }
{                                                                         }
{ Copyright(c) 1995-2010 Embarcadero Technologies, Inc.                   }
{                                                                         }
{ *********************************************************************** }

unit DBXJSON;

...

class function TJSONString.Hex(const Digit: Integer): Byte;
var
  HexData: TBytes;
begin
  SetLength(HexData,16);
  HexData[0] := Ord('0');
  HexData[1] := Ord('1');
  HexData[2] := Ord('2');
  HexData[3] := Ord('3');
  HexData[4] := Ord('4');
  HexData[5] := Ord('5');
  HexData[6] := Ord('6');
  HexData[7] := Ord('7');
  HexData[8] := Ord('8');
  HexData[9] := Ord('9');
  HexData[10] := Ord('A');
  HexData[11] := Ord('B');
  HexData[12] := Ord('C');
  HexData[13] := Ord('D');
  HexData[14] := Ord('E');
  HexData[15] := Ord('F');
  Result := HexData[Digit];
end;

Kein Kommentar ist auch ein Kommentar ... bzw. das ist kommentarlos schon schlimm genug.

Wobei man hätte gern noch kommentieren können, was beim Aufruf von TJSONString.Hex(12345) passieren könnte.

[Namenloser]

WTF? Arbeiten bei Embarcadero nur noch Praktikanten? Kein Wunder, dass der 64-Bit-Compiler so lange auf sich warten lässt...