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.

markieren

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:


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

Zitat:

<code>
Vorformatierter Text, wie z.B. Quellcode

Hat jemand einen Rat?

Danke vorab.

Hm, das ist wirklich unschön.
Folgender Workaround funktioniert bei mir in Tokyo:

markieren

Delphi-Quellcode:

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

...

Zitat von TiGü:

Hm, das ist wirklich unschön.
Folgender Workaround funktioniert bei mir in Tokyo:

markieren

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...