DocumentationProvider Classe

Definizione

Classe utilizzata per fornire la documentazione XML al compilatore per i membri dai metadati. Un'implementazione personalizzata di questa classe deve essere restituita da documentationResolver per fornire commenti di documentazione XML da cache o percorsi personalizzati.

public ref class DocumentationProvider abstract
public abstract class DocumentationProvider
type DocumentationProvider = class
Public MustInherit Class DocumentationProvider
Ereditarietà
DocumentationProvider
Derivato

Costruttori

DocumentationProvider()

Classe utilizzata per fornire la documentazione XML al compilatore per i membri dai metadati. Un'implementazione personalizzata di questa classe deve essere restituita da documentationResolver per fornire commenti di documentazione XML da cache o percorsi personalizzati.

Proprietà

Default

Classe utilizzata per fornire la documentazione XML al compilatore per i membri dai metadati. Un'implementazione personalizzata di questa classe deve essere restituita da documentationResolver per fornire commenti di documentazione XML da cache o percorsi personalizzati.

Metodi

Equals(Object)

Gli oggetti DocumentationProvider vengono confrontati quando si determina se è possibile riutilizzare un assemblySymbol. Pertanto, se più istanze possono rappresentare la stessa documentazione, è fondamentale eseguire l'override di Equals (e GetHashCode) per acquisire questo fatto. In caso contrario, è possibile terminare con più assemblySymbols per lo stesso assembly, che gioca con la gerarchia dei tipi.

GetDocumentationForSymbol(String, CultureInfo, CancellationToken)

Recupera un commento della documentazione per l'ID membro specificato.

GetHashCode()

Gli oggetti DocumentationProvider vengono confrontati quando si determina se è possibile riutilizzare un assemblySymbol. Pertanto, se più istanze possono rappresentare la stessa documentazione, è fondamentale eseguire l'override di GetHashCode (e Equals) per acquisire questo fatto. In caso contrario, è possibile terminare con più assemblySymbols per lo stesso assembly, che gioca con la gerarchia dei tipi.

Si applica a