Eure besten Quellcode Kommentare...

[rokli]

Wenns ginge, würde ich Dir dafür ein "Sternchen" geben, MaBuSE!

[MaBuSE]

Zitat von rokli:

Wenns ginge, würde ich Dir dafür ein "Sternchen" geben, MaBuSE!

Vielen Dank für die Blumen ...

[Neutral General]

Zitat von MaBuSE:

Zitat von rokli:

Wenns ginge, würde ich Dir dafür ein "Sternchen" geben, MaBuSE!

Vielen Dank für die Blumen ...

I see what you did there

[Der schöne Günther]

Code:

(kein if, keine Prüfung)
allControllersHealthy := True; // Wir sind Optimisten

[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

[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

[MaBuSE]

Zitat von haentschman:

PS: FDFix war eine Query

Dann mach doch einfach folgendes draus, wenn Du dich dann besser fühlst.

Delphi-Quellcode:

...
if Data.FDFix.State in [dsInactive, dsOpening] then Data.FDFix.Close;
...

Das sieht doch gleich viel wichtiger aus.
Ist aber faktisch das selbe, da:

Delphi-Quellcode:

...
function TDataSet.GetActive: Boolean;
begin
  Result := not (State in [dsInactive, dsOpening]);
end;
...
procedure TDataSet.Close;
begin
  Active := False;
end;
...

ps: Falls es niemand gemerkt hat, dieser Beitrag ist ironisch gemeint. haentschman hat Recht. Das ist natürlich Blödsinn.