Eure besten Quellcode Kommentare...

[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

[Codehunter]

Da liegt das Problem aber in der Implementierung des Setters:

Zitat von MaBuSE:

Delphi-Quellcode:

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
      (* ... *)
    finally
      WriteLn('Ende');
      FDFix.Free;
    end;
    ReadLn;
  except
    on E: Exception do
      WriteLn(E.ClassName, ': ', E.Message);
  end;

end.

Das sollte man eigentlich immer so machen, um derlei Probleme zu vermeiden:

Delphi-Quellcode:

procedure TFDFix.SetActive(const Value: Boolean);
begin
  if Value = FActive then 
    Exit 
  else 
  begin
    FActive := Value;
  try
    WriteLn('Start');
    FDFix := TFDFix.Create;
    try
      (* ... *)
    finally
      WriteLn('Ende');
      FDFix.Free;
    end;
    ReadLn;
  except
    on E: Exception do
      WriteLn(E.ClassName, ': ', E.Message);
  end;
  end;
end.

(Hier im Browser editiert, daher bitte die Einrückungen dazu denken)

[MaBuSE]

Zitat von Codehunter:

Delphi-Quellcode:

procedure TFDFix.SetActive(const Value: Boolean);
begin
  if Value = FActive then 
    Exit 
  else 
  begin
    FActive := Value;
    // ...
  end;
end;

dann bitte aber so:

Delphi-Quellcode:

procedure TFDFix.SetActive(const Value: Boolean);
begin
  if Value <> FActive then 
  begin
    FActive := Value;
    // ...
  end;
end;

Borland/CodeGear/Embarcadero machen das auch so:
Ein schönes Beispiel ist TMargins und TPadding:

Delphi-Quellcode:

 // Quelltext gekürzt !!!

  TMarginSize = 0..MaxInt;

  TMargins = class(TPersistent)
  private
    FLeft, FTop, FRight, FBottom: TMarginSize;
    procedure SetMargin(Index: Integer; Value: TMarginSize);
  protected
    procedure Change; virtual;
  published
    property Left: TMarginSize   index 0 read FLeft   write SetMargin default 3;
    property Top: TMarginSize    index 1 read FTop    write SetMargin default 3;
    property Right: TMarginSize  index 2 read FRight  write SetMargin default 3;
    property Bottom: TMarginSize index 3 read FBottom write SetMargin default 3;
  end;

  TPadding = class(TMargins)
  published
    property Left   default 0;
    property Top    default 0;
    property Right  default 0;
    property Bottom default 0;
  end;

procedure TMargins.SetMargin(Index: Integer; Value: TMarginSize);
begin
  case Index of
    0:if Value <> FLeft then
      begin
        FLeft := Value;
        Change;
      end;
    1:if Value <> FTop then
      begin
        FTop := Value;
        Change;
      end;
    2:if Value <> FRight then
      begin
        FRight := Value;
        Change;
      end;
    3:if Value <> FBottom then
      begin
        FBottom := Value;
        Change;
      end;
  end;
end;

[ConnorMcLeod]

Delphi-Quellcode:

  try
    [... code hier ...]
  except
    // ist mir sowas von egal
  end;

[Sherlock]

Delphi-Quellcode:

  try
[... code zum schreiben in eine Log Datei...]
  except
    // Well, what should we do? What is best practice here?
  end;

¯\_(ツ)_/¯

Sherlock

[Codehunter]

Jetzt nicht direkt Quelltext-Kommentar, aber dennoch einen Platz in dieser Hall of Shame wert: Microsoft

Zitat:

Wenn Sie die Audioverbesserungen deaktivieren, kann dies die Soundqualität verbessern.

Demnach müsste man ja nur ständig Bleifuß fahren, um besonders sparsam unterwegs zu sein. Geile Sache das...

[Uwe Raabe]

Delphi-Quellcode:

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

Wer weiß denn schon, ob not True auch wirklich gleich False ist? Der Code ist vermutlich schon für den Einsatz auf einem Quanten-Computer vorbereitet. (Schönen Gruß von Erwin Schrödinger)

[haentschman]

Zitat:

Das sollte man aber Kommentieren!!!

...ich meinte nicht das so stehen zu lassen...ich meinte "ohne Worte"
PS: FDFix war eine Query