ISymbol.GetDocumentationCommentXml 方法

定义

命名空间:

Microsoft.CodeAnalysis

程序集:

Microsoft.CodeAnalysis.dll

包:

Microsoft.CodeAnalysis.Common v4.9.2

Source:

ISymbol.cs

获取与符号关联的注释的文本) 的 XML (。

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

（可选）展开 <包含> 元素。 不会影响非源文档注释。

cancellationToken

CancellationToken

允许取消请求的令牌。

返回

String

将写入符号的文档文件的 XML。