DocumentationProvider Classe

Définition

Espace de noms:

Microsoft.CodeAnalysis

Assembly:

Microsoft.CodeAnalysis.dll

Paquet:

Microsoft.CodeAnalysis.Common v4.9.2

Source:

DocumentationProvider.cs

Classe utilisée pour fournir une documentation XML au compilateur pour les membres à partir de métadonnées. Une implémentation personnalisée de cette classe doit être retournée par un DocumentResolver pour fournir des commentaires de documentation XML à partir de caches ou d’emplacements personnalisés.

public ref class DocumentationProvider abstract

public abstract class DocumentationProvider

type DocumentationProvider = class

Public MustInherit Class DocumentationProvider

Héritage

Object

DocumentationProvider

Dérivé

Microsoft.CodeAnalysis.XmlDocumentationProvider

Constructeurs

DocumentationProvider()

Classe utilisée pour fournir une documentation XML au compilateur pour les membres à partir de métadonnées. Une implémentation personnalisée de cette classe doit être retournée par un DocumentResolver pour fournir des commentaires de documentation XML à partir de caches ou d’emplacements personnalisés.

Propriétés

Default

Classe utilisée pour fournir une documentation XML au compilateur pour les membres à partir de métadonnées. Une implémentation personnalisée de cette classe doit être retournée par un DocumentResolver pour fournir des commentaires de documentation XML à partir de caches ou d’emplacements personnalisés.

Méthodes

Equals(Object)	Les documentationProviders sont comparés pour déterminer si un assemblySymbol peut être réutilisé. Par conséquent, si plusieurs instances peuvent représenter la même documentation, il est impératif que Equals (et GetHashCode) soient substitués pour capturer ce fait. Sinon, il est possible de se retrouver avec plusieurs AssemblySymbols pour le même assembly, qui joue un appel avec la hiérarchie de type.
GetDocumentationForSymbol(String, CultureInfo, CancellationToken)	Récupère un commentaire de documentation pour l’ID de membre donné.
GetHashCode()	Les documentationProviders sont comparés pour déterminer si un assemblySymbol peut être réutilisé. Par conséquent, si plusieurs instances peuvent représenter la même documentation, il est impératif que GetHashCode (et Equals) soient substitués pour capturer ce fait. Sinon, il est possible de se retrouver avec plusieurs AssemblySymbols pour le même assembly, qui joue un appel avec la hiérarchie de type.