Eure besten Quellcode Kommentare...

[Relicted]

huhu!

da ich gerade mal durch etwas ältere quellcodes stöbere und mir mal wieder ein doofer kommentar nach dem anderen aufgefallen ist dachte ich mir ich mach mal einen thread raus und frage mal dumm in die runde was ihr noch so in euren qullcodes gefunden habt :-)

vielleicht haben ja einige von euch lust sich zu beteiligen :-) mich würds freuen...
ich mach dann mal direkt den anfang...

Delphi-Quellcode:

{2006-03-02, warum immer wieder vom Anfang ?????}
{2006-03-15, weil ich zu dem zeitpunktals ich die routine geschrieben habe einen promillewert von 2,5 hatte und mir
daher dec ned eingefallen ist glaub ich :-p }

Delphi-Quellcode:

  //...
  except
    // Fehler nur schlucken!
    // Anmerkung: JAAAAA SCHLUCK DU LUDER :-))
  end;

gruß
reli

[Neutral General]

Hi,

Delphi-Quellcode:

{ 29.03.06mm: Umstellung von Indy auf IPPro }
{ 30.03.06mm: Umstellung von IPPro auf Indy }
{ 01.04.06mm: Umstellung von Indy auf IPPro -.- }

Delphi-Quellcode:

{ AuthPackages }
  TSendAuthPackage = packed record
    // PackageID
    ID: Word; // = 1
    // Länge des Usernamens (Test = 4)
    Userlength: Word;
    // Der Username
    Username: string;
    // Passwort, MD5Bytes Array
    Password: TMD5Digest;
  end;

  TGetAuthPackage = packed record
    // PackageID
    ID: Word; // = 1
    // Hat die Authentifizierung geklappt? True = Ja, False = Nein
    AuthOk: Boolean;
  end;

[ANMERKUNG: Der ganze Quelltext geht so weiter...]
[...]

{ Hauptsache ma alles mit Kommentaren zugespamt -.- }

Mehr hab ich jetzt nicht gefunden...

[Dezipaitor]

Delphi-Quellcode:

{
    The security identifier (SID) structure is a variable-length structure used to uniquely identify users or groups.

    @ClassName encapsulates a SID structures and provides functions to create, read and convert SID data.
    Once an instance is created the SID data cannot be changed. Therefore there is no Assign function to copy data.

    MSDN on [url]http://msdn2.microsoft.com/en-us/library/aa379594.aspx[/url]
                     [url]http://msdn2.microsoft.com/en-us/library/aa379597.aspx[/url]
    }
    TSecurityID = class(TObject)
    private
      {}
      fWellKnownSidType : TWellKnownSidType;

      {}
      fSID : PSid;

      {@Name contains the values of the properties of the instance for debugging purposes.}
      fDbgData : String;

      {@Name disables the raising of exceptions in the following methods :
        +GetAccountSidString
       It is used for debugging purposes (hiding internal exceptions) only.
      }
      fDbgDisableException : Boolean;

      {@Name updates the variable @link(fDbgData) for debugging purposes.
       It is called in the constructors of @classname.
        }
      procedure UpdateDbgData; virtual;
    public
      {@Name allocates memory for a SID and returns the pointer to it.
       The size of allocated memory is always the maximum possible size of a
        SID. The constant SECURITY_MAX_SID_SIZE is used.
       The data must be freed by @link(FreeSID).
       @return(@Name returns a pointer to the newly created SID)
       @raises(ESMNotEnoughMemory will be raised if not enough memory is available)
       }
      class function NewSID : PSid;

      {@Name frees a SID allocated by @Link(NewSID).
       @param(SID contains the sid memory to be freed. If the variable is nil nohting will happen.
              The parameter will be nil after a succesfull call)
       }
      class procedure FreeSID(var SID : PSID);


      {@Name creates a new SID initilized sid. The values are copied from this SID instance.
       The SID must be freed by @link(FreeSID).
       }
      function CreateCopyOfSID : PSID;
....
....

Im allgemeinen sieht man, dass ich doch mehr oder weniger viel kommentiere.
Jedoch beachte man die leeren Kommentarklammern gleich nach TSecurityID = class(TObject) .
Ein schlimmes Vergehen meine Ansicht nach! Die Frage ist jedoch, ob die Kommentierung von geschützten Klasseninhalten notwendig sind, wenn dieselben noch veröffentlicht und kommentiert auftauchen ?

Delphi-Quellcode:

...
public
       {@Name contains a pointer to the internal SID structure.
        The SID structure must not be freed by CloseHandle otherwise the behavior of the instance is undefined.
        }
        property SID : PSid read fSid;

      {@Name returns the SID type as a well known sid type.

        The value is the parameter value given in CreateWellKnownSid as parameter WellKnownSidType.
        Otherwise the value is always WinNullSid;
       }
       property WellKnownSidType : TWellKnownSidType read GetWellKnownSidType;
...

Zitat:

Zitat von Relicted

Delphi-Quellcode:

{2006-03-02, warum immer wieder vom Anfang ?????}
{2006-03-15, weil ich zu dem zeitpunktals ich die routine geschrieben habe einen promillewert von 2,5 hatte und mir
daher dec ned eingefallen ist glaub ich :-p }

Würde mich mal interessieren.
Schreibst du diese Art von Programmen nur für dich persönlich, oder für Auftraggeber?

[Relicted]

das ist ein produkt... also kein auftraggeber der den code bekommt...
der erste kommentar war von meinem chef der 2. dann von mir... und der ist auch nur pure ironie.. mir ist keine bessere ausrede eingefallen :-p

heutzutage nutze ich folgende seite: http://www.peterkleemann.de/cgi/bofhserver-cgi.pl :-)

[HariboHunter]

Delphi-Quellcode:

// test

Ohne Datum , ohne Angaben, Ohne Hinweise.

[Dezipaitor]

Ich hab mich schon gefragt, wie man mit 0,25 % Alk im Blut noch was schreiben kann. Oder gibts auch Tastaturen mit riesigen Tasten?
Aber selbst dabei dürfte nichts rauskommen.

Delphi-Quellcode:

//irgendwas funkz hier net richtig

In jedem Kommentar steckt ein Funken Wahrheit.

[Lun]

Delphi-Quellcode:

 // Upload fehlgeschlagen, entsprechend reagieren
        ShowMessage('no result');

Super reagiert :shock:

So eine Fehlerbehandlung wünscht sich doch jeder User :mrgreen:

greetz Lun

[Relicted]

Delphi-Quellcode:

//str 2003-06-13 (yeah, Freitag der 13. der Sensemann kommt)
//Damit die MessageBox (z.B. 5 Kanäle aus 3 Messungen stimmt)
BOOL bOK = FALSE;

gerade von einem c kollegen reingeflattert :-)

[Torpedo]

Delphi-Quellcode:

// ka, funktioniert noch nicht

:P

[Dax]

Code:

// nen besseren Namen gibt es einfach nicht
Node _;

[Robert Marquardt]

Das IOCCC-Programm das wie Line Garbage aussieht ist schon viele Jahre alt. Da ist dieser Node doch ein eher schwaechlicher Versuch.

[Dax]

Das ist kein Versuch, irgendetwas zu toppen - es ist lediglich ein Stück aus einem schon etwas älteren Programm. Und da ich ja (Schande über mich) so gut wie garnichts kommentiere, war die Auswahl nicht gerade groß ;)

[RavenIV]

In meiner alten Firma war ein Kollege, der immer lustige Kommentare geschrieben hat.
Immerhin hat er immer seine Kommentare mit Datum und Name versehen...

Die Zeilen in /*...*/ sind Anmerkungen von mir.

Delphi-Quellcode:

// so öppis bruuch kei Sau!
/* 10 Zeilen auskommentiert */

// da hat jemand was auskommentiert
/* 3 Zeilen auskommentiert */

// alles Murks, das versteht doch keiner
/* komplette Funktion ausgetauscht */

// der Name "blabla" für eine Variable ist nicht zulässig
/* aber geändert hat er es nicht */

Das sind nur einige seiner tollen Kommentare.
Beim durchblättern der Sourcen hat man öfters einen Lachanfall bekommen...

[Relicted]

chi chi verständlich :-)

[FAlter]

Hi,

Sammlung aus versch. Projekten, aber es sieht dürftig aus... :oops:
Jede Leerzeile bedeutet hier, dass es nichts mit dem vorigen zu tun hat.

Delphi-Quellcode:

    //Spielerstatusänderungsprocedure
    procedure ProcessSpielerstatus;

    begin
      Beep; //Noch nicht implementiert...
    end;


      //WriteBuf('MTrk' + #$00#$00#$00#$04#$00#$FF#$2F#$00); //Wenns hilft?

        if Lautstaerke = 0 then //Kein Ton...


  const
    VFakt = 5;
  //Lautstärkeverringerungsfaktor


        //TODO!

    //...

Aus meinem OS-Versuch:

Code:

      ;FAlterOS Kernel 0.0.0
      ;This is the Kernel of FAlterOS :-)


      ;TODO:
      ;- nearly everything

;Felix Alter, 21st June 2005 (my 17th Birthday :-D)

Eigentlich aus PHP (live-Berechnung, wie alt ich bin :mrgreen: )...

Code:

   '.' /* Tausenderseparator
     man weiß ja nie, wie alt ich mal werde ;) */

Mfg
FAlter

[EWeiss]

Der beste kommentar ist keinen zu schreiben.

Wie dieser hier .. der keiner sein soll ;)

gruss

[MaBuSE]

Wir hatten mal ein Projekt in dem fand ich folgenden Kommentar:

Delphi-Quellcode:

...
// Datum, Username1: Wer das liesst ist doof.
// Datum, Username2: Wer das geschrieben hat, bekommt eine Abmahnung!
...

Datum weiß ich nicht mehr genau, das war bei meinem ehemaligen Arbeitgeber.
Username1 war der Username eines Programmierers.
Username2 war das Login von unserem Cheff.
Der Quelltext wurde an Kunden ausgeliefert und der Kunde hat die Zeile entdeckt.
-> Der Kunde hat unseren Cheff angerufen.
-> Cheffe hat den 2. Kommentar druntergesetzt.

Ich habe das irgendwann mal im Quellcode gefunden und Cheffe darauf angesprochen.
Er hatte nur gegrinst. Ob der Programmierer wirklich eine Abmahnung bekam weiß ich nicht. ;-)

[OlafSt]

Code:

  
//STK 26.03.2002 - auskommentiert, man beachte die sache mit den rb_beiWarnng
//ausserdem total oversized true und false wenn activated ??? <- muhahahaha
//OST 09.04.2002 - Aber nur, bis Chef auf die Idee kommt, bei activated=true
//                 noch ein paar andere Dinge umzustellen. Dann mach ich muhahahaha :))))

Ich erinnerte mich beim Lesen dieses Threads an diesen kurzen Disput mit meinem Teamkollegen damals... Inzwischen ist das Programm 7 Jahre alt und beim Compile bleibt der Zeilenzähler nach 68 Sekunden bei 16 Mio. stehen, die ursprüngliche Firma (und ihren Chef) gibts nicht mehr, aber das Programm lebt und wird noch immer von mir betreut und erweitert.

Nur nebenbei erwähnt gebührt meinem Kollegen die Ehre - er hatte Recht, Chef wolle nie was bei "activated=true" :cheers:

[Tormentor32]

Das hier hab ich mal gesehen:

Delphi-Quellcode:

// Kein Kommentar!

[Andidreas]

war zwar kein quellcode kommentar, sondern nur in meinen notizen zu einer besprechung, aber hab grad trotzdem bisl schmunzeln müssen dadrüber:

Delphi-Quellcode:

// GAP (Programmanforderung) gecancelt --> Whatever

*gg*

[FAlter]

Hi,

Ein dynamisch erstelltes SynEdit soll auf einem TabSheet liegen...

Delphi-Quellcode:

SynEdit.Parent := CodeSheet; { Kot-Shit ;-D }

Mfg
FAlter

[MaBuSE]

Delphi-Quellcode:

// don't try this at home!

Das war die Überschrift zu einem recht abendheuerlich programmierten Workarround.


oder was man auch recht häufig sieht:

Delphi-Quellcode:

...
procedure KlassenName.MethodenName(...);
begin
  // tbd
end;
...

tbd steht für "to be done" -> muß noch gemacht werden.

Ich persönlich hätte ehr folgendes eingefügt:

Delphi-Quellcode:

...
procedure KlassenName.MethodenName(...);
begin
  {$message warn 'KlassenName.MethodenName(...) noch nicht implementiert.'}
end;
...

Damit wird beim kompilieren eine Warnung ausgegeben.

[Phoenix]

Zitat:

Zitat von MaBuSE

Delphi-Quellcode:

...
procedure KlassenName.MethodenName(...);
begin
  {$message warn 'KlassenName.MethodenName(...) noch nicht implementiert.'}
end;
...

Damit wird beim kompilieren eine Warnung ausgegeben.

Und das sagst Du mir erst jetzt?!? :cyclops:

[MaBuSE]

Zitat:

Zitat von Phoenix

Und das sagst Du mir erst jetzt?!? :cyclops:

Steht doch in der Hilfe von Delphi :stupid:

Zitat aus der Delphi 7 Hilfe:

MESSAGE (Direktive)

Syntax

Delphi-Quellcode:

{$MESSAGE HINT|WARN|ERROR|FATAL 'Textstring' }

Anmerkungen

• Diese Direktive ermöglicht dem Quelltext, wie der Compiler Hinweise, Warnungen und Fehlermeldungen zu generieren. Sie ähnelt den Anweisungen #emit und pragma warn in C/C++.
  Der Meldungstyp (HINT, WARN, ERROR oder FATAL) ist optional. Ohne diese Angabe wird HINT verwendet. Der Textstring muss angegeben und in einfache Anführungszeichen eingeschlossen werden.

Beispiele:

Delphi-Quellcode:

{$MESSAGE 'Boo!'} //Hinweis

{$Message Hint 'Füttere die Katzen'}    // Hinweis
{$messaGe Warn 'Sieht nach Regen aus.'} // Warnung
{$Message Error 'Nicht implementiert'}  // Fehler, die Compilierung wird fortgesetzt
{$Message Fatal 'Bang.  Tot.'} // Fehler, die Compilierung wird abgebrochen

[Die Muhkuh]

Hi,

die Direktive ist ja nett, kannte ich bis jetzt auch noch nicht :)

[MaBuSE]

Zitat:

Zitat von Die Muhkuh

die Direktive ist ja nett, kannte ich bis jetzt auch noch nicht :)

Und das ist noch nicht mal offtopic, die Direktiven sind ja in {} eingeklammert und somit eigentlich auch nur ein Kommentar :mrgreen:

[Phoenix]

Kann man mit einem anderen Kommentar Compilerschalter auch Messages mit bestimmten Levels unterdrücken? Meine Hints werden nämlich nicht angezeigt, die Warnings und Errors schon.

[Khabarakh]

Da finde ich es sinnvoller, in der Methode eine Exception zu werfen (VS generiert an solchen Stellen einen NotImplementedException-Aufrufwurf).
Dass unfertige Codeteile in einem Build vorhanden sind, ist nichts Abnormales; sollten diese Codeteile aber im Programm aufgerufen werden, ist irgendetwas gehörig schief gegangen und dann erwarte ich auch eine Fehlermeldung. Nicht dass sich noch jemand wundert, warum der noch gar nicht implementierte Zufallsgenerator immer 42 zurückgibt :stupid: . Und wenn die Ursache mal wieder in einer verlängerten Kaffee-Session mit fehlerhafter Abbruchbedingungen zu suchen ist, wäre eine ECupNotYetEmpty-Exception angebracht.

[Phoenix]

Ich hab mal eine EUserTooStupidException implementiert. .oO

[smudo]

Die Message-Direktive ist wirklich ein guter Tipp. Fällt auf jeden Fall sofort auf, sofern man sauber programmiert und nicht eh schon jede Menge Warnungen ausgegeben bekommt :zwinker:
Weniger störend verhält sich da ein Todo-Eintrag {ToDo 1 -cKategorie -oUserName: blabla}

[MaBuSE]

Zitat:

Zitat von Phoenix

Kann man mit einem anderen Kommentar Compilerschalter auch Messages mit bestimmten Levels unterdrücken? Meine Hints werden nämlich nicht angezeigt, die Warnings und Errors schon.

Ja, kann man.

Damit dieser Thread nicht zu offtopic wird, habe ich zum Thema Warnungen und Hinweise vom Compiler einen neuen Thread aufgemacht.
http://www.delphipraxis.net/internal...t.php?t=115445

Viel Spaß beim Lesen :mrgreen:

[Die Muhkuh]

Du bist der Beste, MaBuSe ;)

[EDatabaseError]

Jetzt wirds aber OT ;-)

[MaBuSE]

Zitat:

Zitat von Die Muhkuh

Du bist der Beste, MaBuSe ;)

Danke, dabei fällt mir noch ein Kommentar ein, den ich selbst mal in einem Programm geschrieben habe:

Delphi-Quellcode:

...
  // IBM, Code muß verifiziert werden !!!
...

IBM steht für "ich bin müde" :mrgreen:

[turboPASCAL]

Meine lieblingskomments in einem Quellcode:

;)

Delphi-Quellcode:

// ...

Delphi-Quellcode:

// mach ich noch

Delphi-Quellcode:

// rechnen üben oder sein lassen, blöde formelkrams

[OlafSt]

Gerade entdeckt:

Delphi-Quellcode:

// MSR: Wenn ein Ruf abgewiesen wird, erhält der Monitoring Service nur
// die Nachricht Mon-CC-Information mit der Meldung Disconnect.
// Wenn ein Button vorhanden ist muss dieser gelöscht werden, wenn noch
// keiner vorhanden ist, muss dieser entfernt werden. (MSR - 10.03.04)

In einem meiner anderen Programme gestern abend drüber gestolpert:

Delphi-Quellcode:

case EventNo of
  0: asm
        nop;  //Do positively nothing
     end;
  1: HandleResize;
  [...]
end;

[fLaSh11]

Hab ich heute morgen in nem alten QC gefunden: :mrgreen:

Delphi-Quellcode:

procedure TForm1.NoName;
begin
  //noch nichts
end;

[LukeGee]

Aus meinem aktuellen Projekt:

Delphi-Quellcode:

//string[] Deutsch = new string[GET_Count()]; <- so wars vorher. war shitty.

[3_of_8]

Auch aus meinem aktuellen Projekt:

Delphi-Quellcode:

  token:=TryGetToken(TokenList, Index);
  if token.TokenType=tkIdentifier then
    func:=token.Content
  else
    exit; //Throw WTF-were-you-thinking-when-calling-this-method-exception
  inc(Index);

  token:=TryGetToken(TokenList, Index);
  if (token.TokenType<>tkSeparator) or (token.Content<>'(') then
    exit; //Second verse, same as the first
  inc(Index);

[Hansa]

Noch was aktuelles :

Zitat:

// Art.Nr. stimmt und ist auch richtig sortiert, aber :
// Postionen und andere Daten total verkehrt.
hjsdhfddfhjal // Compiler anhalten und Objectlist überprüfen !!
// Günzburg 15.6.08 1:10

Man beachte Datum, Uhrzeit und Ort. :mrgreen: Kein Fake ! Eher Erleuchtung und bis Ulm war das lokalisiert. :shock: