XmlDocumentationProvider Класс

Определение

Пространство имен:

Microsoft.CodeAnalysis

Сборка:

Microsoft.CodeAnalysis.Workspaces.dll

Пакет:

Microsoft.CodeAnalysis.Workspaces.Common v4.9.2

Source:

XmlDocumentationProvider.cs

Класс, используемый для предоставления XML-документации компилятору для членов из метаданных из источника 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

Наследование

Object

DocumentationProvider

XmlDocumentationProvider

Конструкторы

XmlDocumentationProvider()

Класс, используемый для предоставления XML-документации компилятору для членов из метаданных из источника XML-документа.

Методы

CreateFromBytes(Byte[])	XmlDocumentationProvider Создает данные XML-документации из байтов.
CreateFromFile(String)	Создает файл XmlDocumentationProvider xml-документации.
Equals(Object)	DocumentationProviders сравниваются при определении возможности повторного использования AssemblySymbol. Таким образом, если несколько экземпляров могут представлять одну и ту же документацию, крайне важно переопределить equals (и GetHashCode) для записи этого факта. В противном случае можно в конечном итоге с несколькими сборками AssemblySymbols для одной сборки, которая играет хаос с иерархией типов. (Унаследовано от DocumentationProvider)
GetDocumentationForSymbol(String, CultureInfo, CancellationToken)	Класс, используемый для предоставления XML-документации компилятору для членов из метаданных из источника XML-документа.
GetHashCode()	DocumentationProviders сравниваются при определении возможности повторного использования AssemblySymbol. Таким образом, если несколько экземпляров могут представлять одну и ту же документацию, необходимо переопределить GetHashCode (и Equals) для записи этого факта. В противном случае можно в конечном итоге с несколькими сборками AssemblySymbols для одной сборки, которая играет хаос с иерархией типов. (Унаследовано от DocumentationProvider)
GetSourceStream(CancellationToken)	Возвращает исходный поток для XML-документа.