AGB  ·  Datenschutz  ·  Impressum  







Anmelden
Nützliche Links
Registrieren
Zurück Delphi-PRAXiS Sprachen und Entwicklungsumgebungen Die Delphi-IDE Elemente eines Aufzählungstyps/Enums mit XML-Kommentaren versehen
Thema durchsuchen
Ansicht
Themen-Optionen

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

Offene Frage von "RSE"
Ein Thema von RSE · begonnen am 4. Okt 2012 · letzter Beitrag vom 4. Okt 2012
Antwort Antwort
RSE

Registriert seit: 26. Mär 2010
254 Beiträge
 
Delphi XE Enterprise
 
#1

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

  Alt 4. Okt 2012, 17:06
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.
"Seit er seinen neuen Computer hat, löst er alle seine Probleme, die er vorher nicht hatte."
  Mit Zitat antworten Zitat
Benutzerbild von himitsu
himitsu

Registriert seit: 11. Okt 2003
Ort: Elbflorenz
43.142 Beiträge
 
Delphi 12 Athens
 
#2

AW: Elemente eines Aufzählungstyps/Enums mit XML-Kommentaren versehen

  Alt 4. Okt 2012, 17:48
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.
Garbage Collector ... Delphianer erzeugen keinen Müll, also brauchen sie auch keinen Müllsucher.
my Delphi wish list : BugReports/FeatureRequests

Geändert von himitsu ( 4. Okt 2012 um 17:54 Uhr)
  Mit Zitat antworten Zitat
RSE

Registriert seit: 26. Mär 2010
254 Beiträge
 
Delphi XE Enterprise
 
#3

AW: Elemente eines Aufzählungstyps/Enums mit XML-Kommentaren versehen

  Alt 4. Okt 2012, 18:45
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).
"Seit er seinen neuen Computer hat, löst er alle seine Probleme, die er vorher nicht hatte."
  Mit Zitat antworten Zitat
Antwort Antwort


Forumregeln

Es ist dir nicht erlaubt, neue Themen zu verfassen.
Es ist dir nicht erlaubt, auf Beiträge zu antworten.
Es ist dir nicht erlaubt, Anhänge hochzuladen.
Es ist dir nicht erlaubt, deine Beiträge zu bearbeiten.

BB-Code ist an.
Smileys sind an.
[IMG] Code ist an.
HTML-Code ist aus.
Trackbacks are an
Pingbacks are an
Refbacks are aus

Gehe zu:

Impressum · AGB · Datenschutz · Nach oben
Alle Zeitangaben in WEZ +1. Es ist jetzt 15:38 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