ISymbol.GetDocumentationCommentXml Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets the XML (as text) for the comment associated with the symbol.
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 StringParameters
- preferredCulture
- CultureInfo
Preferred culture or null for the default.
- expandIncludes
- Boolean
Optionally, expand <include> elements. No impact on non-source documentation comments.
- cancellationToken
- CancellationToken
Token allowing cancellation of request.
Returns
The XML that would be written to the documentation file for the symbol.
Applies to
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
