Поделиться через


ISymbol.GetDocumentationCommentXml Метод

Определение

Возвращает XML-код (в виде текста) для комментария, связанного с символом.

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

Параметры

preferredCulture
CultureInfo

Предпочитаемый язык и региональные параметры или null для значения по умолчанию.

expandIncludes
Boolean

При необходимости разверните <элементы include> . Не влияет на комментарии, не относящиеся к исходной документации.

cancellationToken
CancellationToken

Токен, разрешающий отмену запроса.

Возвращаемое значение

XML, который будет записан в файл документации для символа.

Применяется к