Eure besten Quellcode Kommentare...

[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;

[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.

[himitsu]

Manmal würde ich mir wünschen, wenn es überhaupt Kommentare oder wenigstens eine halbwegs verständliche Hilfe gäbe,
aber wenn man schon tagelang verzweifelt sucht und von einem Problem ins nächste stolpert,
und dann einen Artikel findet, ala "The Worst API Ever Made",
dann vergeht einem auch das letzte Bissl an Lust.

Wenn ich mal was fand und dort standen Kommentare ... dann stimmten sie garnicht.

Und der einzige gut aussehende Code, als Antwort auf eine Frage ....... der bracht mitten drin ab.



https://caseymuratori.com/blog_0025

Hatte die überschrift erst garnicht gesehn und dachte "geil", endlich mal was, das ausführlich aussieht und wirklich um das geht, was ich suche (nicht um irgendwas anderes, mit dem Wort "Trace")

[MaBuSE]

Zitat von himitsu:

Manmal würde ich mir wünschen, wenn es überhaupt Kommentare oder wenigstens eine halbwegs verständliche Hilfe gäbe,

Das kenne ich.

Ich habe auch schon Projekte gesehen, die mehrere Mio Zeilen Quelltext lang sind und per Definition in ca. einer Stunde entstanden sein müssen.
Na ja, bei uns gibt es eine Arbeitsanweisung, dass ca. 10% der Zeit für Dokumentation einzuplanen ist.
Und der/die Entwickler haben sich nicht mal 10 Min Zeit genommen für Doku und Kommentare.

[dummzeuch]

Besser gar keine Kommentare als falsche oder sinnlose ala

Delphi-Quellcode:

// *******************
// * Prozdur bla     *
// *******************
procedure bla;
var
  i: integer; // Schleifenvariable
begin
  // alle Listenelemente durchlaufen
  for i := 0 to Liste.Count -1 do begin
    // Listenelement verarbeiten
    Process(Liste[i]);
  end;
end;

letztere reduzieren die Lesbarkeit ohne irgendwas beizutragen.

Programmierer sollten sich besser auf verständlichen Code (Struktur und Namensgebung) konzentrieren als auf Teufel komm raus Kommentare zu schreiben. Kommentare sollen beschreiben, warum etwas auf eine bestimmte Weise gemacht wird, und das auch nur dann, wenn es nicht offensichtlich ist.

[DeddyH]

[Uwe Raabe]

Zitat von dummzeuch:

Programmierer sollten sich besser auf verständlichen Code (Struktur und Namensgebung) konzentrieren als auf Teufel komm raus Kommentare zu schreiben. Kommentare sollen beschreiben, warum etwas auf eine bestimmte Weise gemacht wird, und das auch nur dann, wenn es nicht offensichtlich ist.

Zitat von Brian W Kernighan and P. J. Plaugher:

Don't comment bad code - rewrite it.