ISymbol.GetDocumentationCommentXml Метод

  • Ссылка

Определение

Пространство имен:
Microsoft.CodeAnalysis
Сборка:
Microsoft.CodeAnalysis.dll
Пакет:
Microsoft.CodeAnalysis.Common v3.0.0
Пакет:
Microsoft.CodeAnalysis.Common v3.1.0
Пакет:
Microsoft.CodeAnalysis.Common v3.10.0
Пакет:
Microsoft.CodeAnalysis.Common v3.11.0
Пакет:
Microsoft.CodeAnalysis.Common v3.2.0
Пакет:
Microsoft.CodeAnalysis.Common v3.2.1
Пакет:
Microsoft.CodeAnalysis.Common v3.3.1
Пакет:
Microsoft.CodeAnalysis.Common v3.4.0
Пакет:
Microsoft.CodeAnalysis.Common v3.5.0
Пакет:
Microsoft.CodeAnalysis.Common v3.6.0
Пакет:
Microsoft.CodeAnalysis.Common v3.7.0
Пакет:
Microsoft.CodeAnalysis.Common v3.8.0
Пакет:
Microsoft.CodeAnalysis.Common v3.9.0
Пакет:
Microsoft.CodeAnalysis.Common v4.0.1
Пакет:
Microsoft.CodeAnalysis.Common v4.1.0
Пакет:
Microsoft.CodeAnalysis.Common v4.2.0
Пакет:
Microsoft.CodeAnalysis.Common v4.3.1
Пакет:
Microsoft.CodeAnalysis.Common v4.4.0
Пакет:
Microsoft.CodeAnalysis.Common v4.5.0
Пакет:
Microsoft.CodeAnalysis.Common v4.6.0
Пакет:
Microsoft.CodeAnalysis.Common v4.7.0
Пакет:
Microsoft.CodeAnalysis.Common v4.8.0
Пакет:
Microsoft.CodeAnalysis.Common v4.9.2
Source:
ISymbol.cs
Source:
ISymbol.cs
Source:
ISymbol.cs
Source:
ISymbol.cs
Source:
ISymbol.cs
Source:
ISymbol.cs
Source:
ISymbol.cs
Source:
ISymbol.cs
Source:
ISymbol.cs

Возвращает 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

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

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

String

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

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