ISymbol.GetDocumentationCommentXml Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Obtém o XML (como texto) para o comentário associado ao símbolo.
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
Parâmetros
- preferredCulture
- CultureInfo
Cultura preferencial ou nulo para o padrão.
- expandIncludes
- Boolean
Opcionalmente, expanda <elementos de inclusão> . Nenhum impacto nos comentários da documentação não-fonte.
- cancellationToken
- CancellationToken
Token que permite o cancelamento da solicitação.
Retornos
O XML que seria gravado no arquivo de documentação do símbolo.
Aplica-se a
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de