ISymbol.GetDocumentationCommentXml Méthode

Définition

Espace de noms:

Microsoft.CodeAnalysis

Assembly:

Microsoft.CodeAnalysis.dll

Paquet:

Microsoft.CodeAnalysis.Common v4.9.2

Source:

ISymbol.cs

Obtient le code XML (en tant que texte) du commentaire associé au symbole.

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

Paramètres

preferredCulture

CultureInfo

Culture préférée ou null pour la valeur par défaut.

expandIncludes

Boolean

Si vous le souhaitez, développez <les éléments inclus> . Aucun impact sur les commentaires de documentation non source.

cancellationToken

CancellationToken

Jeton autorisant l’annulation de la demande.

Retours

String

XML qui serait écrit dans le fichier de documentation du symbole.