Delphi-PRAXiS

Delphi-PRAXiS (https://www.delphipraxis.net/forum.php)
-   Die Delphi-IDE (https://www.delphipraxis.net/62-die-delphi-ide/)
-   -   Zeilenumbruch in Symbolbeschreibungen (https://www.delphipraxis.net/168278-zeilenumbruch-symbolbeschreibungen.html)

Jaynder 12. Mai 2012 18:17

Zeilenumbruch in Symbolbeschreibungen
 
Liste der Anhänge anzeigen (Anzahl: 1)
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)

Sir Rufo 12. Mai 2012 20:58

AW: Zeilenumbruch in Symbolbeschreibungen
 
ich glaube das geht mit einem weiteren remarks block
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>
  /// <remarks>und in separater Zeile</remarks>
  TAlfa = class
    ...
  end;

Jaynder 14. Mai 2012 06:51

AW: Zeilenumbruch in Symbolbeschreibungen
 
Liste der Anhänge anzeigen (Anzahl: 1)
gute idee, leider keine Lösung. Text wird einfach zusammengezogen

Panthrax 14. Mai 2012 09:42

AW: Zeilenumbruch in Symbolbeschreibungen
 
Delphi-Quellcode:
    ///   <remarks>
    ///     <para>
    ///       Absatz
    ///     </para>
    ///     <para>
    ///       Absatz
    ///     </para>
    ///   </remarks>

Jaynder 14. Mai 2012 15:44

AW: Zeilenumbruch in Symbolbeschreibungen
 
:thumb: mange tak panthrax, genauso gehts

Panthrax 15. Mai 2012 00:22

AW: Zeilenumbruch in Symbolbeschreibungen
 
Værsågod!


Alle Zeitangaben in WEZ +1. Es ist jetzt 19:12 Uhr.

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