DocumentationProvider.GetDocumentationForSymbol Método

Definição

Namespace:

Microsoft.CodeAnalysis

Assembly:

Microsoft.CodeAnalysis.dll

Pacote:

Microsoft.CodeAnalysis.Common v4.9.2

Source:

DocumentationProvider.cs

Busca um comentário de documentação para a ID de membro fornecida.

protected internal abstract string? GetDocumentationForSymbol (string documentationMemberID, System.Globalization.CultureInfo preferredCulture, System.Threading.CancellationToken cancellationToken = default);

abstract member GetDocumentationForSymbol : string * System.Globalization.CultureInfo * System.Threading.CancellationToken -> string

Protected Friend MustOverride Function GetDocumentationForSymbol (documentationMemberID As String, preferredCulture As CultureInfo, Optional cancellationToken As CancellationToken = Nothing) As String

Parâmetros

documentationMemberID

String

A ID do membro da documentação do item a ser buscado.

preferredCulture

CultureInfo

A cultura preferencial para receber um comentário. Nulo se não houver preferência. Essa é apenas uma preferência, e os provedores podem optar por fornecer resultados de outra cultura se a cultura preferencial não estiver disponível.

cancellationToken

CancellationToken

Um token de cancelamento para a pesquisa.

Retornos

String

Um DocumentationComment.