DocumentationProvider Clase

Definición

Espacio de nombres:

Microsoft.CodeAnalysis

Ensamblado:

Microsoft.CodeAnalysis.dll

Paquete:

Microsoft.CodeAnalysis.Common v4.9.2

Source:

DocumentationProvider.cs

Clase que se usa para proporcionar documentación XML al compilador para los miembros de los metadatos. Se debe devolver una implementación personalizada de esta clase desde documentationResolver para proporcionar comentarios de documentación XML desde cachés personalizadas o ubicaciones.

public ref class DocumentationProvider abstract

public abstract class DocumentationProvider

type DocumentationProvider = class

Public MustInherit Class DocumentationProvider

Herencia

Object

DocumentationProvider

Derivado

Microsoft.CodeAnalysis.XmlDocumentationProvider

Constructores

DocumentationProvider()

Clase que se usa para proporcionar documentación XML al compilador para los miembros de los metadatos. Se debe devolver una implementación personalizada de esta clase desde documentationResolver para proporcionar comentarios de documentación XML desde cachés personalizadas o ubicaciones.

Propiedades

Default

Clase que se usa para proporcionar documentación XML al compilador para los miembros de los metadatos. Se debe devolver una implementación personalizada de esta clase desde documentationResolver para proporcionar comentarios de documentación XML desde cachés personalizadas o ubicaciones.

Métodos

Equals(Object)	DocumentationProviders se comparan al determinar si se puede reutilizar un AssemblySymbol. Por lo tanto, si varias instancias pueden representar la misma documentación, es imperativo que Equals (y GetHashCode) se invaliden para capturar este hecho. De lo contrario, es posible terminar con varios AssemblySymbols para el mismo ensamblado, que juega a problemas con la jerarquía de tipos.
GetDocumentationForSymbol(String, CultureInfo, CancellationToken)	Captura un comentario de documentación para el identificador de miembro especificado.
GetHashCode()	DocumentationProviders se comparan al determinar si se puede reutilizar un AssemblySymbol. Por lo tanto, si varias instancias pueden representar la misma documentación, es imperativo que GetHashCode (y Equals) se invaliden para capturar este hecho. De lo contrario, es posible terminar con varios AssemblySymbols para el mismo ensamblado, que juega a problemas con la jerarquía de tipos.