IDE-Expert gesucht zur Visualisierung von Überarbeitungen

[TurboMagic]

Würde man XMLDOC für die Kommentare nutzen, könnte man den entsprechenden Kommentar sehen,
wenn man weiter unten im Code über einen Aufruf dieser mit der Maus fährt. Beispiel:

Delphi-Quellcode:

type
  TMyClass = class
  public
    /// <summary>
    ///  Version 1
    /// </summary>
    procedure DoIt1;
  end;

[himitsu]

Wobei in die Beschreibung eher war Anders reingehört. (die kann man sich ja nun von der AI generieren lassen )

Dann doch eher so?

Delphi-Quellcode:

/// <summary> Diese Funktion macht irgendwas, auch wenn niemand weiß was. </summary>
/// <remarks> Version 1 </remarks>
procedure DoIt1;

... oder vielleicht doch?
/// <summary> Version 1: Diese Funktion macht irgendwas, auch wenn niemand weiß was. </summary>
procedure DoIt2;

[vnvjan]

Warum nicht zusätzlich noch:

Delphi-Quellcode:

{$region 'Version XYZ' 
...
$endregion}

zum Kommentieren benutzen. So bleibt der Code sauberer und man kann sich Teile nur im Editor anzeigen lassen, die man wirklich braucht.

[Uwe Raabe]

Das mit der Region wäre in der Tat ein alternativer Ansatz, wenn man jeweils die bereits bearbeiteten Methoden in die Region verschiebt. In diesem Beispiel stehen die noch zu bearbeitenden Methoden dann immer am Anfang der Deklaration:

Delphi-Quellcode:

type
  TKlasseXY = class
    procedure C;
{$region 'V1' }
    procedure A;
    procedure B;
{$endregion}
  end;

[tgvoelker]

DocInsight habe ich. Für Doku gut, für Methodenversionierung eher nicht.

In Kommentar reinschreiben war mein erster Ansatz - sehe ich halt nicht auf den ersten Blick was ich noch machen muß.