ISymbol.GetDocumentationCommentXml Methode
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Ruft den XML-Code (als Text) für den Kommentar ab, der dem Symbol zugeordnet ist.
public string GetDocumentationCommentXml (System.Globalization.CultureInfo preferredCulture = default, bool expandIncludes = false, System.Threading.CancellationToken cancellationToken = default);
public string? GetDocumentationCommentXml (System.Globalization.CultureInfo? preferredCulture = default, bool expandIncludes = false, System.Threading.CancellationToken cancellationToken = default);
abstract member GetDocumentationCommentXml : System.Globalization.CultureInfo * bool * System.Threading.CancellationToken -> string
Public Function GetDocumentationCommentXml (Optional preferredCulture As CultureInfo = Nothing, Optional expandIncludes As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As String
Parameter
- preferredCulture
- CultureInfo
Bevorzugte Kultur oder Null für den Standardwert.
- expandIncludes
- Boolean
Optional können Sie> Elemente erweitern<. Keine Auswirkungen auf Nicht-Quelldokumentationskommentare.
- cancellationToken
- CancellationToken
Token, das die Kündigung der Anforderung zulässt.
Gibt zurück
Der XML-Code, der in die Dokumentationsdatei für das Symbol geschrieben wird.