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

必要に応じて、include> 要素を展開します<。 ソース以外のドキュメント コメントには影響しません。

cancellationToken

CancellationToken

要求の取り消しを許可するトークン。

戻り値

String

シンボルのドキュメント ファイルに書き込まれる XML。