Verschlüsselung bzw. Entschlüsselung will nicht gelingen

[dataspider]

Wenn du warnst, Anfängern nicht solche Tipps wie: guter Code braucht keine Kommentare" zu geben, dann ist das deine Sicht.

Ich wäre heute glücklich, wenn ich damals als Anfänger solche Hinweise bekommen hätte.
Denn erst gerade diese Regeln (sehr gut beschrieben in Clean Code) haben mir tatsächlich nennenswerte Zeit erspart.
Zeit, die ich mit Kommentaren niemals sparen kann sondern wohl eher verschwende.

Und wer es einmal erlebt hat, Code wie ein Buch zu lesen, der wird diese Regel niemals mehr in Frage stellen.

Frank

[cookie22]

"Guter Code braucht keine Kommentare." Ist aus meiner Sicht ein schlechter Tipp, gerade für Anfänger, weil ein Anfänger wohl kaum den Durchblick hat, ob etwas sauber programmiert ist oder nicht. Das verführt nur dazu "schlecht Code" nicht auszukommentieren. Ich schlage mich täglich mit solchem Mist herum, wo ich mir denke, was hat der Typ sich hierbei nur gedacht. Dann geht das große Rätselraten los, obwohl eine Kommentarzeile schon alles hatte erklären können. Besonders toll ist so etwas bei Workarounds, welche einem völlig Sinnfrei erscheinen ohne Kommentar.

Vielleicht können wir uns auf: "Guter Code braucht wenig Kommentare." einigen. ;)

[Uwe Raabe]

Es könnte hier der Eindruck enstehen, Kommentare seien das neue GOTO oder WITH. Dem ist nun wahrlich nicht so!

[Sir Rufo]

Hier mal der Caesar-Cipher der fast keine Kommentare benötigt

Delphi-Quellcode:

unit Caesar;

interface

type

  // siehe http://de.wikipedia.org/wiki/Caesar-Verschlüsselung

  TCaesarCipher = class
  private const
    CCharCount = 26; // 26 Buchstaben im Alphabet
    CFirstPlainChar = 'a'; // Klartext in Kleinbuchstaben und startet mit 'a'
    CFirstCryptChar = 'A'; // Geheimtext in Großbuchstaben und startet mit 'A'
  private
    function GetPositiveShift( AShift : Integer ) : Integer;
    function GetShiftedCode( ACode, AShift : Integer ) : Integer;
  public
    function Encrypt( const APlainStr : string; AShift : Integer ) : string;
    function Decrypt( const ACryptStr : string; AShift : Integer ) : string;
  end;

implementation

{ TCaesarCipher }

function TCaesarCipher.GetPositiveShift( AShift : Integer ) : Integer;
begin
  Result := AShift mod CCharCount; // -CCharCount+1 .. CCharCount-1
  Result := Result + CCharCount; // 1 .. 2*CCharcount-1
  Result := Result mod CCharCount; // 0 .. CCharCount-1
end;

function TCaesarCipher.GetShiftedCode( ACode, AShift : Integer ) : Integer;
begin
  // Bei einer festen Anzahl x ist es egal, ob man 2 zurück oder (x-2) vor geht
  // Start ....... : 1(2)3 4 5
  // 2 zurück .... : 1 2 3 4(5)
  // (5-2) = 3 vor : 1 2 3 4(5)
  Result := ( ACode + GetPositiveShift( AShift ) ) mod CCharCount;
end;

function TCaesarCipher.Decrypt( const ACryptStr : string; AShift : Integer ) : string;
var
  LStrLength : Integer;
  LStrIndex : Integer;
  LPlainChar : Char;
  LCryptChar : Char;
  LPlainCode : Integer;
  LCryptCode : Integer;
begin
  LStrLength := Length( ACryptStr );
  SetLength( Result, LStrLength );
  for LStrIndex := 1 to LStrLength do
  begin
    LCryptChar := ACryptStr[LStrIndex];
    LCryptCode := Ord( LCryptChar ) - Ord( CFirstCryptChar );
    { TODO : Überprüfung von 0 <= LCryptCode < CCharCount }
    LPlainCode := GetShiftedCode( LCryptCode, - AShift );
    LPlainChar := Char( LPlainCode + Ord( CFirstPlainChar ) );
    Result[LStrIndex] := LPlainChar;
  end;
end;

function TCaesarCipher.Encrypt( const APlainStr : string; AShift : Integer ) : string;
var
  LStrLength : Integer;
  LStrIndex : Integer;
  LPlainChar : Char;
  LCryptChar : Char;
  LPlainCode : Integer;
  LCryptCode : Integer;
begin
  LStrLength := Length( APlainStr );
  SetLength( Result, LStrLength );
  for LStrIndex := 1 to LStrLength do
  begin
    LPlainChar := APlainStr[LStrIndex];
    LPlainCode := Ord( LPlainChar ) - Ord( CFirstPlainChar );
    { TODO : Überprüfung von 0 <= LPlainCode < CCharCount }
    LCryptCode := GetShiftedCode( LPlainCode, AShift );
    LCryptChar := Char( LCryptCode + Ord( CFirstCryptChar ) );
    Result[LStrIndex] := LCryptChar;
  end;
end;

end.

Wie man sieht benötigt man keine Kommentare um die Funktionsweise des Codes trotzdem lesbar zu gestalten.
Die Funktionsweise des Caesar-Ciphers muss man aber schon vorher verstanden haben.

Ein Code ist schließlich nicht dazu da eine Thematik zu erklären, sondern die Thematik umzusetzen.
Wer die Thematik verstanden hat, sollte dann auch den Code verstehen können.

HINWEIS
Der Code ist bewusst nicht DRY ...