Eure besten Quellcode Kommentare...

[FAlter]

Hi,

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

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

[MaBuSE]

// 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 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?!?

[MaBuSE]

Zitat von Phoenix:

Und das sagst Du mir erst jetzt?!?

Steht doch in der Hilfe von Delphi

Zitat aus der Delphi 7 Hilfe:

MESSAGE (Direktive)

Syntax{$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 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

[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 . 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
Weniger störend verhält sich da ein Todo-Eintrag {ToDo 1 -cKategorie -oUserName: blabla}