XmlDocumentationProvider クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
XML ドキュメント ソースのメタデータからメンバーの XML ドキュメントをコンパイラに提供するために使用されるクラス。
public ref class XmlDocumentationProvider abstract : Microsoft::CodeAnalysis::DocumentationProviderpublic abstract class XmlDocumentationProvider : Microsoft.CodeAnalysis.DocumentationProvidertype XmlDocumentationProvider = class
inherit DocumentationProviderPublic MustInherit Class XmlDocumentationProvider
Inherits DocumentationProvider- 継承
コンストラクター
| XmlDocumentationProvider() |
XML ドキュメント ソースのメタデータからメンバーの XML ドキュメントをコンパイラに提供するために使用されるクラス。 |
メソッド
| CreateFromBytes(Byte[]) |
XML ドキュメント データを XmlDocumentationProvider 表す from バイトを作成します。 |
| CreateFromFile(String) |
XML ドキュメント ファイルから作成 XmlDocumentationProvider します。 |
| Equals(Object) |
DocumentationProviders は、AssemblySymbol を再利用できるかどうかを判断するときに比較されます。 そのため、複数のインスタンスが同じドキュメントを表すことができる場合は、Equals (と GetHashCode) をオーバーライドしてこの事実をキャプチャすることが不可欠です。 そうしないと、同じアセンブリに対して複数の AssemblySymbols が生成され、型階層で大混乱を引き起こす可能性があります。 (継承元 DocumentationProvider) |
| GetDocumentationForSymbol(String, CultureInfo, CancellationToken) |
XML ドキュメント ソースのメタデータからメンバーの XML ドキュメントをコンパイラに提供するために使用されるクラス。 |
| GetHashCode() |
DocumentationProviders は、AssemblySymbol を再利用できるかどうかを判断するときに比較されます。 そのため、複数のインスタンスが同じドキュメントを表すことができる場合は、この事実をキャプチャするために GetHashCode (と Equals) をオーバーライドすることが不可欠です。 そうしないと、同じアセンブリに対して複数の AssemblySymbols が生成され、型階層で大混乱を引き起こす可能性があります。 (継承元 DocumentationProvider) |
| GetSourceStream(CancellationToken) |
XML ドキュメントのソース ストリームを取得します。 |
適用対象
.NET