ISymbol.GetDocumentationCommentXml Metodo

Definizione

Spazio dei nomi:

Microsoft.CodeAnalysis

Assembly:

Microsoft.CodeAnalysis.dll

Pacchetto:

Microsoft.CodeAnalysis.Common v4.9.2

Source:

ISymbol.cs

Ottiene il codice XML (come testo) per il commento associato al simbolo.

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

Parametri

preferredCulture

CultureInfo

Impostazioni cultura preferite o Null per l'impostazione predefinita.

expandIncludes

Boolean

Facoltativamente, espandere <includere> gli elementi. Nessun impatto sui commenti della documentazione non di origine.

cancellationToken

CancellationToken

Token che consente l'annullamento della richiesta.

Restituisce

String

Codice XML che verrebbe scritto nel file di documentazione per il simbolo.