Quellcode Kommentieren

[franktron]

Kennt jemand eine Erweiterung für Delphi (XE2) die Automatich ein Kommentar für eine Procedure erstellt

[himitsu]

Wie AUTOMATISCH?
Und wenn wo soll der Text her kommen?

Documentaion Insight
Codevorlagen
...

[ChristianG]

Die Kommentare musst du selbst schreiben. Oder du schreibst ein Programm, was künstliche Intelligenz hat, um deine Logik zu erkennen. Das sollte nicht böse gemeint sein, sondern eher zeigen, dass solch ein Programm sehr komplex ist und möglicherweise noch nicht realisierbar. Also einfach weiter mit // kommentieren :) .
Oder möglicherweise habe ich die Frage nicht verstanden :/.
Mit freundlichen Grüßen

[franktron]

Ich hatte mal eine Erweiterung die das machte

Bsp.
//*******************************
//Procedurenname Param1 Param1
//Erstallt am xx.xx.xxxx von Frank
//Geändert am xx.xx.xxxx von Frank
//***********************************

[Bernhard Geyer]

Es geht vermutlich eher um die Textvorlagen das das "Drumherum" um den eigentlichen Kommentar automatisch eingefügt wird.
Also Eingabe von /// und dann soll die IDE automatisch die Parameter ergänzen so das man wirklich nur den eigenen Beschreibungstext eingeben muss.

[bernau]

Zitat:

Zitat von franktron (Beitrag 1267504)

Ich hatte mal eine Erweiterung die das machte

Bsp.
//*******************************
//Procedurenname Param1 Param1
//Erstallt am xx.xx.xxxx von Frank
//Geändert am xx.xx.xxxx von Frank
//***********************************

GExperts kann so etwas. Nutze ich permanent.

[franktron]

Zitat:

Zitat von bernau (Beitrag 1267507)

Zitat:

Zitat von franktron (Beitrag 1267504)

Ich hatte mal eine Erweiterung die das machte

Bsp.
//*******************************
//Procedurenname Param1 Param1
//Erstallt am xx.xx.xxxx von Frank
//Geändert am xx.xx.xxxx von Frank
//***********************************

GExperts kann so etwas. Nutze ich permanent.

Wo ? ich hab den

[bernau]

Menü->GExperts->Editor Experts->Expand Macro Templates

Oder Shift-Alt-T

Dann aus der Liste "Procedure Header" auswählen. Kannst du natürlich anpassen.

[sx2008]

Also bei uns in der Abteilung war das auch mal schwer in Mode *grundsätzlich* vor jede Funktion/Procedure/Methode einen Kommentarblock zu setzen.
Aber wenn man mal darüber nachdenkt, kommt man drauf dass das eigentlich ziemlich dumm ist.
Denn meistens steht im Kommentar nicht mehr als in der Funktion selber.
Wann eine Funktion erstellt und geändert wurde ist relativ uninteressant werden man eine Versionsverwaltung verwendet.
Und wenn man keine Versionsverwaltung hat dann wird's aber höchste Eisenbahn.

Die Nachteile der Zwangskommentare sind:
* Zeitverschwendung durch Einfügen und Pflegen von Kommentaren die keinen Zusatznutzen bringen
* visuelles Störfeuer - je mehr Zeichen auf dem Bildschirm sind umso mehr Kapazität benötigt das menschliche Gehirn um Wichtiges von Unwichtigem zu trennen
* die Stellen die wirklich mal einen Kommentar haben fallen gar nicht auf weil überall Kommentare stehen
* anstatt darüber nachzudenken wie man die Funktionen sprechender machen könnte verlässt man sich auf nutzlose Kommentare die im Zweifelsfall doch eh falsch sind weil sich Funktionsname und/oder Parameter geändert haben

Meine Empfehlung:
vor wichtigen/komplizierten/erklärungsbedüftigen Funktionen schreibt man eine Kommentarezeile die kurz beschreibt was die Funktion macht.
Hier ein Beispiel:

Delphi-Quellcode:

// wandelt einen Speicherbereich in einen hexadezimalen String
function BufferToHexString(buffer:Pointer;size:Integer):AnsiString;
begin
   if not Assigned(buffer) or (size<=0) then
      Result := ''
   else
   begin
      SetLength(Result, size*2);
      BinToHex(PChar(buffer), PChar(Result), size);
   end;
end;

Wobei in obigem Beispiel der Funktionsname schon so sprechend ist dass man auf den Kommentar auch verzichten könnte.
Mehr als eine Zeile zu schreiben ist nicht verboten!

[mjustin]

Zitat:

Zitat von sx2008 (Beitrag 1267519)

Die Nachteile der Zwangskommentare sind:
* Zeitverschwendung durch Einfügen und Pflegen von Kommentaren die keinen Zusatznutzen bringen

Mein Lieblingsbeispiel für Kommentare ohne Zusatznutzen:

Delphi-Quellcode:

  TForm1 = class(TForm)
  private
    { Private declarations }
  public
    { Public declarations }
  end;

;)