Delphi-PRAXiS

Delphi-PRAXiS (https://www.delphipraxis.net/forum.php)
-   Die Delphi-IDE (https://www.delphipraxis.net/62-die-delphi-ide/)
-   -   Elemente eines Aufzählungstyps/Enums mit XML-Kommentaren versehen (https://www.delphipraxis.net/170827-elemente-eines-aufzaehlungstyps-enums-mit-xml-kommentaren-versehen.html)

RSE 4. Okt 2012 17:06


Elemente eines Aufzählungstyps/Enums mit XML-Kommentaren versehen
 
Hallo,

ist es möglich, dass man den Elementen eines Aufzählungstyps einen XML-Kommentar verpassen kann, der dann auch durch den Tooltip ausgewertet wird? Für den Enumtyp an sich geht das ja, nur für dessen Elemente hab ich es noch nicht hinbekommen und auch nie gefunden, wie das gehen sollte. Natürlich könnte man die Kommentare zu den Elementen im Kommentar des Typs mit unterbringen, aber dann ist der Kommentar nicht mehr am Element und man vergisst bei Änderungen schnell den Kommentar zu ändern. Zudem gibt es vielleicht auch einen Compiler-Hinweis wie bei den Argumenten einer Methode, wenn man nicht alle Elemente des Enums dokumentiert.
Delphi-Quellcode:
  /// <summary>Das wird angezeigt</summary>
  TMyEnum = (
    /// <summary>Das wird leider nicht angezeigt</summary>
    meElem1,
    /// <summary>Das hätte ich aber gern angezeigt</summary>
    meElem2
  );
Bitte fragt nicht wozu und warum, sondern akzeptiert einfach, dass ich an dieser Stelle manchmal diese Kommentare hilfreich finde. Nicht immer reicht ein guter Name restlos aus, um alle Unklarheiten über die Verwendung zu beseitigen.

himitsu 4. Okt 2012 17:48

AW: Elemente eines Aufzählungstyps/Enums mit XML-Kommentaren versehen
 
Kommentare nein, denn diese fliegen beim Compilieren raus und landen niemals in der EXE.

Allerdings kannst du Attribute verwenden.
Delphi-Quellcode:
[TMyInfo('Das wird angezeigt')]
TMyEnum = (
  [TMyInfo('Das wird leider nicht angezeigt')]
  meElem1,
  [TMyInfo('Das hätte ich aber gern angezeigt')]
  meElem2
);
Ich glaub da konnte man auch zu jedem Enum-Value einen Wert hinterlegen.
Falls nicht, dann mußt du eben diese String-Liste beim Typ mit reinmachen.




[edit]
Falsch verstanden.
Du meinst anzeigen im Code-Insight und nicht in einem Programm?

Hmmm, wenn dann weiß ich jetzt auch nichts.
Wenn das nicht unterstützt wird (nicht implementiert wurde), dann geht's halt nicht.

RSE 4. Okt 2012 18:45

AW: Elemente eines Aufzählungstyps/Enums mit XML-Kommentaren versehen
 
Ja, ich meinte Code-Insight ;-) Von diesen Attributen lese ich jetzt das erste Mal. Hat sicher was mit RTTI zu tun?

Wenn es nicht implementiert ist, dann geht es nicht, klare Sache. Wenn das noch jemand bestätigt, würde ich das natürlich auch als Antwort gelten lassen (ich lese mal in deine Worte hinein, dass du dir nicht sicher bist).


Alle Zeitangaben in WEZ +1. Es ist jetzt 10:24 Uhr.

Powered by vBulletin® Copyright ©2000 - 2024, Jelsoft Enterprises Ltd.
LinkBacks Enabled by vBSEO © 2011, Crawlability, Inc.
Delphi-PRAXiS (c) 2002 - 2023 by Daniel R. Wolf, 2024 by Thomas Breitkreuz