Einzelnen Beitrag anzeigen

Benutzerbild von Jaynder
Jaynder

Registriert seit: 2. Dez 2004
Ort: Süderelbe
134 Beiträge
 
Delphi 10.4 Sydney
 
#1

Zeilenumbruch in Symbolbeschreibungen

  Alt 12. Mai 2012, 18:17
Hallo, ich beschäftige mich gerade mit der Erstellung von erweiterten Symbolbeschreibungen für meine Objektklassen. Da ich hier im Forum nichts darübergefunden habe, hier mal eine kurze Beschreibung, worum es dabei geht:

Setzt man folgendes direkt vor den Namen der Klasse
Delphi-Quellcode:
type
  /// <summary> *Alfa* dies steht oben *Alfa* </summary>
  /// <remarks> *Alfa* dies steht unter remarks
  /// und kann sich auch über viele Zeilen erstrecken. *Alfa*</remarks>
  TAlfa = class
    ...
  end;
Ist unter "Tools|Umgebungsoptionen|Editor-Optionen|Code Insight" der Haken bei "Symbolbeschreibung" gesetzt, poppt ein Informationsfenster auf, sobald man irgendwo im Quelltext mit der Maus auf das Symbol TAlfa fährt. Dieses ist dann mit den eigenen Informationen ergänzt. Da dies auch für die Methoden der Klasse geht, kann man so prima eine Online-Dokumentation der eigenen Klassen erstellen.

Dazu nun folgende Frage: Der Text wird als wortweiser Fließtext behandelt, kann man irgendwie Einfluss auf die Formatierung nehmen?

(Standard HTML-Tags wie z.B. <br> gehen nicht, dann wird der eigene Text komplett ignoriert)
Miniaturansicht angehängter Grafiken
symbolbeschreibung.jpg  
  Mit Zitat antworten Zitat