XmlDocumentationProvider Classe

Definizione

Spazio dei nomi:

Microsoft.CodeAnalysis

Assembly:

Microsoft.CodeAnalysis.Workspaces.dll

Pacchetto:

Microsoft.CodeAnalysis.Workspaces.Common v4.9.2

Source:

XmlDocumentationProvider.cs

Classe usata per fornire la documentazione XML al compilatore per i membri dai metadati da un'origine documento 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

Ereditarietà

Object

DocumentationProvider

XmlDocumentationProvider

Costruttori

XmlDocumentationProvider()

Classe usata per fornire la documentazione XML al compilatore per i membri dai metadati da un'origine documento XML.

Metodi

CreateFromBytes(Byte[])	Crea un XmlDocumentationProvider oggetto da byte che rappresenta i dati della documentazione XML.
CreateFromFile(String)	Crea un oggetto XmlDocumentationProvider da un file di documentazione XML.
Equals(Object)	Gli elementi DocumentationProvider vengono confrontati quando si determina se è possibile riutilizzare un assemblySymbol. Pertanto, se più istanze possono rappresentare la stessa documentazione, è imperativo 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. (Ereditato da DocumentationProvider)
GetDocumentationForSymbol(String, CultureInfo, CancellationToken)	Classe usata per fornire la documentazione XML al compilatore per i membri dai metadati da un'origine documento XML.
GetHashCode()	Gli elementi DocumentationProvider vengono confrontati quando si determina se è possibile riutilizzare un assemblySymbol. Pertanto, se più istanze possono rappresentare la stessa documentazione, è imperativo 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. (Ereditato da DocumentationProvider)
GetSourceStream(CancellationToken)	Ottiene il flusso di origine per il documento XML.