AGB  ·  Datenschutz  ·  Impressum  







Anmelden
Nützliche Links
Registrieren
Thema durchsuchen
Ansicht
Themen-Optionen

XML Doku - Beispielcode

Offene Frage von "WiPhi"
Ein Thema von WiPhi · begonnen am 18. Sep 2019 · letzter Beitrag vom 18. Sep 2019
Antwort Antwort
WiPhi

Registriert seit: 19. Feb 2015
90 Beiträge
 
Delphi 11 Alexandria
 
#1

XML Doku - Beispielcode

  Alt 18. Sep 2019, 09:12
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:
delphi_xml_doku-_code.jpg

Lt. Delphi Dokumenatationn sollte es aber mit <code> funktionieren:
Zitat:
<code>
Vorformatierter Text, wie z.B. Quellcode
Hat jemand einen Rat?

Danke vorab.
Wer sucht, der findet. Wer länger sucht, findet mehr.
  Mit Zitat antworten Zitat
TiGü

Registriert seit: 6. Apr 2011
Ort: Berlin
3.070 Beiträge
 
Delphi 10.4 Sydney
 
#2

AW: XML Doku - Beispielcode

  Alt 18. Sep 2019, 09:29
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>
  Mit Zitat antworten Zitat
freimatz

Registriert seit: 20. Mai 2010
1.456 Beiträge
 
Delphi 11 Alexandria
 
#3

AW: XML Doku - Beispielcode

  Alt 18. Sep 2019, 09:56
...

Geändert von freimatz (18. Sep 2019 um 09:59 Uhr) Grund: (wie löscht man denn einen Beitrag?)
  Mit Zitat antworten Zitat
WiPhi

Registriert seit: 19. Feb 2015
90 Beiträge
 
Delphi 11 Alexandria
 
#4

AW: XML Doku - Beispielcode

  Alt 18. Sep 2019, 10:01
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...
Wer sucht, der findet. Wer länger sucht, findet mehr.
  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 01:43 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