Einzelnen Beitrag anzeigen

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, 18: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