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