Delphi-PRAXiS

Delphi-PRAXiS (https://www.delphipraxis.net/forum.php)
-   Die Delphi-IDE (https://www.delphipraxis.net/62-die-delphi-ide/)
-   -   XML Doku - Beispielcode (https://www.delphipraxis.net/202001-xml-doku-beispielcode.html)

WiPhi 18. Sep 2019 08:12

XML Doku - Beispielcode
 
Liste der Anhänge anzeigen (Anzahl: 1)
Guten Morgen liebe Delphi-Community,

wir würden gern unseren Code besser Dokumentieren. Hierfür sind ja die XML-Kommentare gedacht. Das funktioniert soweit auch nicht schlecht.
Gern würden wir auch in die Kommentare Beispiel-Code einbauen.
Delphi-Quellcode:
/// <remarks>
///   Die Funktion kann wie folgt verwendet werden:
///   <code>
///     procedure Beispiel;
///     var
///       Variable1: String;
///   </code>
/// </remarks>
procedure Beispiel;
Leider bricht Delphi den in <code> getaggten Kommentar nicht um und es entsteht beim Darüberfahren mit der Maus folgender Effekt:
Anhang 51652

Lt. Delphi Dokumenatationn sollte es aber mit <code> funktionieren:
Zitat:

<code>
Vorformatierter Text, wie z.B. Quellcode
Hat jemand einen Rat?

Danke vorab.

TiGü 18. Sep 2019 08:29

AW: XML Doku - Beispielcode
 
Hm, das ist wirklich unschön.
Folgender Workaround funktioniert bei mir in Tokyo:

Delphi-Quellcode:
    /// <remarks>
    /// Die Funktion kann wie folgt verwendet werden:
    /// <code>procedure Beispiel;</code>
    /// <code>var</code>
    /// <code> Variable1: String;</code>
    /// </remarks>

freimatz 18. Sep 2019 08:56

AW: XML Doku - Beispielcode
 
...

WiPhi 18. Sep 2019 09:01

AW: XML Doku - Beispielcode
 
Zitat:

Zitat von TiGü (Beitrag 1446808)
Hm, das ist wirklich unschön.
Folgender Workaround funktioniert bei mir in Tokyo:

Delphi-Quellcode:
    /// <remarks>
    /// Die Funktion kann wie folgt verwendet werden:
    /// <code>procedure Beispiel;</code>
    /// <code>var</code>
    /// <code> Variable1: String;</code>
    /// </remarks>

Ja darauf sind wir auch schon gekommen. Aber das ist ja.... unschön.

Ich hatte mal vor Jahren gelesen, dass man die Style-Infos, wie er die Dokumentation darstellt anpassen kann. Aber das war noch zu XE2 Zeiten...


Alle Zeitangaben in WEZ +1. Es ist jetzt 16:54 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