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 -> stringPublic 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, который будет записан в файл документации для символа.
Применяется к
Совместная работа с нами на GitHub
Источник этого содержимого можно найти на GitHub, где также можно создавать и просматривать проблемы и запросы на вытягивание. Дополнительные сведения см. в нашем руководстве для участников.
