Eure besten Quellcode Kommentare...

[himitsu]

Deine Funktion funktioniert nicht richtig ... ich seh da noch einen Kommentar.

[himitsu]

if LoadLastValBool(F.ClassName + '_Dogging', True) then begin //Dogging? wtf. Das meint sicher Docking? :-)

Ich verrat besser nicht von wem das Dogging kommt

[himitsu]

Ein sehr gutes Beispiel für gute, hilfreiche und nützliche Kommentare, denn ohne diese wüsste man ja garnicht, was da gemacht wird.

PHP-Quellcode:

// read the step get variable
if(isset($_GET['step'])) $step=$_GET['step']; else $step=0;

// show the header
oc_setup::showheader();

...

// show the footer
oc_setup::showfooter();

[himitsu]

Zitat:

Die TODO stammt von gestern.

Gib mal todo + Leerzeichen in einer leeren Codezeile ein.



with Entry.Aliases[High(Entry.Aliases)] do // yes folks it's a 'with' statement. Get over it.

Quelle: procedure AddEnumElementAliases(TypeInfo: PTypeInfo; const Names: array of string; StartValue: Integer = 0);

[Stevie]

Zitat von himitsu:

Zitat:

with Entry.Aliases[High(Entry.Aliases)] do // yes folks it's a 'with' statement. Get over it.

Quelle: procedure AddEnumElementAliases(TypeInfo: PTypeInfo; const Names: array of string; StartValue: Integer = 0);

Abgesehen davon, dass man mit einer Variable vom Typ PElementAlias exakt denselben Effekt erreicht hätte (asm ist exakt identisch) ...

[dGeek]

Mein wertvollster Kommentar bisher war:

 // HIER

[ConnorMcLeod]

... aus einem übernommenen Quelltext:

Delphi-Quellcode:

procedure Datenerfassung
begin
   // Hier steht der Code für die Datenerfassung
   // ******************************************
...
end;

[haentschman]

...da ist jeder Kommentar unötig.

In dem aktuellen Projekt gefunden:

Delphi-Quellcode:

if (not Data.FDFix.Active) then
begin
  Data.FDFix.Active := False;
end;

(Namen zum Schutz des Verursachers geändert )

[Codehunter]

Zitat von haentschman:

...da ist jeder Kommentar unötig.

In dem aktuellen Projekt gefunden:

Delphi-Quellcode:

if (not Data.FDFix.Active) then
begin
  Data.FDFix.Active := False;
end;

(Namen zum Schutz des Verursachers geändert )

Was denn... Nur so kann man sicher gehen dass es auch wirklich AUS ist und nicht etwa auf STANDBY

[MaBuSE]

Zitat von haentschman:

...da ist jeder Kommentar unötig.

In dem aktuellen Projekt gefunden:

Delphi-Quellcode:

if (not Data.FDFix.Active) then
begin
  Data.FDFix.Active := False;
end;

(Namen zum Schutz des Verursachers geändert )

Das sollte man aber Kommentieren!!!
Schau die das Beispiel mal an. Ok ist etwas konstruiert, aber so was in der Art habe ich leider schon gesehen.
Nur wenn Active False ist und nochmal False gesetzt wird, passiert was. Du entfernst bei einem Refactoring diese Zeilen und in der Produktion beim Kunden knallts.
Aus diesem Grund sollte so was kommentiert werden !!!.

Delphi-Quellcode:

program Data;

{$APPTYPE CONSOLE}
{$R *.res}

uses
  System.SysUtils;

type
  TFDFix = class
  private
    FActive: Boolean;
    procedure SetActive(const Value: Boolean);
  published
    property Active: Boolean read FActive write SetActive;
  end;

var
  FDFix: TFDFix;
  { FDFix }

procedure TFDFix.SetActive(const Value: Boolean);
begin
  if Value = FActive then
    WriteLn('Erwarte das Unerwartete ;)') // In dieser Zeile könnte z.B. etwas wichtiges gemacht werden, was einen Fehler verhindert.
  else
    FActive := Value;
end;

begin
  try
    WriteLn('Start');
    FDFix := TFDFix.Create;
    try
      WriteLn('1: Data.FDFix.Active := True;');
      Data.FDFix.Active := True; // hier passiert nix
      if (not Data.FDFix.Active) then
      begin
        WriteLn('2: Data.FDFix.Active := False;');
        Data.FDFix.Active := False; // das wird ja nie aufgerufen
      end;
      WriteLn('3: Data.FDFix.Active := False;');
      Data.FDFix.Active := False; // hier passiert nix
      if (not Data.FDFix.Active) then
      begin
        WriteLn('4: Data.FDFix.Active := False;');
        Data.FDFix.Active := False; // ups
      end;
    finally
      WriteLn('Ende');
      FDFix.Free;
    end;
    ReadLn;
  except
    on E: Exception do
      WriteLn(E.ClassName, ': ', E.Message);
  end;

end.

Ach ja das Programm bringt folgende Ausgabe:

Code:

Start
1: Data.FDFix.Active := True;
3: Data.FDFix.Active := False;
4: Data.FDFix.Active := False;
Erwarte das Unerwartete ;)
Ende