DocumentationProvider クラス

定義

名前空間:

Microsoft.CodeAnalysis

アセンブリ:

Microsoft.CodeAnalysis.dll

パッケージ:

Microsoft.CodeAnalysis.Common v4.9.2

Source:

DocumentationProvider.cs

メタデータからメンバーの XML ドキュメントをコンパイラに提供するために使用されるクラス。 カスタム キャッシュまたは場所から XML ドキュメント コメントを提供するには、DocumentationResolver からこのクラスのカスタム実装を返す必要があります。

public ref class DocumentationProvider abstract

public abstract class DocumentationProvider

type DocumentationProvider = class

Public MustInherit Class DocumentationProvider

継承

Object

DocumentationProvider

派生

Microsoft.CodeAnalysis.XmlDocumentationProvider

コンストラクター

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 が生成され、型階層で大混乱を引き起こす可能性があります。