ISymbol.GetDocumentationCommentXml Método

Definición

Espacio de nombres:

Microsoft.CodeAnalysis

Ensamblado:

Microsoft.CodeAnalysis.dll

Paquete:

Microsoft.CodeAnalysis.Common v4.9.2

Source:

ISymbol.cs

Obtiene el XML (como texto) del comentario asociado al símbolo.

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

Parámetros

preferredCulture

CultureInfo

Referencia cultural preferida o null para el valor predeterminado.

expandIncludes

Boolean

Opcionalmente, expanda <incluir> elementos. No afecta a los comentarios de documentación que no son de origen.

cancellationToken

CancellationToken

Token que permite la cancelación de la solicitud.

Devoluciones

String

XML que se escribiría en el archivo de documentación del símbolo.