XmlDocumentationProvider Classe

Définition

Espace de noms:

Microsoft.CodeAnalysis

Assembly:

Microsoft.CodeAnalysis.Workspaces.dll

Paquet:

Microsoft.CodeAnalysis.Workspaces.Common v4.9.2

Source:

XmlDocumentationProvider.cs

Classe utilisée pour fournir une documentation XML au compilateur pour les membres à partir de métadonnées à partir d’une source de document XML.

public ref class XmlDocumentationProvider abstract : Microsoft::CodeAnalysis::DocumentationProvider

public abstract class XmlDocumentationProvider : Microsoft.CodeAnalysis.DocumentationProvider

type XmlDocumentationProvider = class
    inherit DocumentationProvider

Public MustInherit Class XmlDocumentationProvider
Inherits DocumentationProvider

Héritage

Object

DocumentationProvider

XmlDocumentationProvider

Constructeurs

XmlDocumentationProvider()

Classe utilisée pour fournir une documentation XML au compilateur pour les membres à partir de métadonnées à partir d’une source de document XML.

Méthodes

CreateFromBytes(Byte[])	Crée une XmlDocumentationProvider valeur à partir d’octets représentant des données de documentation XML.
CreateFromFile(String)	Crée un XmlDocumentationProvider fichier de documentation XML.
Equals(Object)	La documentationProviders est comparée lors de la détermination de la réutilisation d’un assemblySymbol. 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. (Hérité de DocumentationProvider)
GetDocumentationForSymbol(String, CultureInfo, CancellationToken)	Classe utilisée pour fournir une documentation XML au compilateur pour les membres à partir de métadonnées à partir d’une source de document XML.
GetHashCode()	La documentationProviders est comparée lors de la détermination de la réutilisation d’un assemblySymbol. 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. (Hérité de DocumentationProvider)
GetSourceStream(CancellationToken)	Obtient le flux source du document XML.