DocumentationProvider Класс

Определение

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

Microsoft.CodeAnalysis

Сборка:

Microsoft.CodeAnalysis.dll

Пакет:

Microsoft.CodeAnalysis.Common v4.9.2

Source:

DocumentationProvider.cs

Класс, используемый для предоставления XML-документации компилятору для членов из метаданных. Пользовательская реализация этого класса должна быть возвращена из DocumentationResolver для предоставления комментариев XML-документации из пользовательских кэшей или расположений.

public ref class DocumentationProvider abstract

public abstract class DocumentationProvider

type DocumentationProvider = class

Public MustInherit Class DocumentationProvider

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

Object

DocumentationProvider

Производный

Microsoft.CodeAnalysis.XmlDocumentationProvider

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

DocumentationProvider()

Класс, используемый для предоставления XML-документации компилятору для членов из метаданных. Пользовательская реализация этого класса должна быть возвращена из DocumentationResolver для предоставления комментариев XML-документации из пользовательских кэшей или расположений.

Свойства

Default

Класс, используемый для предоставления XML-документации компилятору для членов из метаданных. Пользовательская реализация этого класса должна быть возвращена из DocumentationResolver для предоставления комментариев XML-документации из пользовательских кэшей или расположений.

Методы

Equals(Object)	DocumentationProviders сравнивается при определении возможности повторного использования AssemblySymbol. Поэтому, если несколько экземпляров могут представлять одну и ту же документацию, крайне важно переопределить Equals (и GetHashCode) для записи этого факта. В противном случае можно в конечном итоге получить несколько сборок для одной сборки, которая играет хаос с иерархией типов.
GetDocumentationForSymbol(String, CultureInfo, CancellationToken)	Извлекает комментарий к документации для заданного идентификатора члена.
GetHashCode()	DocumentationProviders сравнивается при определении возможности повторного использования AssemblySymbol. Поэтому, если несколько экземпляров могут представлять одну и ту же документацию, крайне важно переопределить GetHashCode (и Equals), чтобы захватить этот факт. В противном случае можно в конечном итоге получить несколько сборок для одной сборки, которая играет хаос с иерархией типов.