DocumentationProvider Kelas

Definisi

Ruang nama:

Microsoft.CodeAnalysis

Rakitan:

Microsoft.CodeAnalysis.dll

Paket:

Microsoft.CodeAnalysis.Common v4.9.2

Source:

DocumentationProvider.cs

Kelas yang digunakan untuk menyediakan dokumentasi XML kepada pengkompilasi untuk anggota dari metadata. Implementasi kustom kelas ini harus dikembalikan dari DocumentationResolver untuk memberikan komentar dokumentasi XML dari cache atau lokasi kustom.

public ref class DocumentationProvider abstract

public abstract class DocumentationProvider

type DocumentationProvider = class

Public MustInherit Class DocumentationProvider

Warisan

Object

DocumentationProvider

Turunan

Microsoft.CodeAnalysis.XmlDocumentationProvider

Konstruktor

DocumentationProvider()

Kelas yang digunakan untuk menyediakan dokumentasi XML kepada pengkompilasi untuk anggota dari metadata. Implementasi kustom kelas ini harus dikembalikan dari DocumentationResolver untuk memberikan komentar dokumentasi XML dari cache atau lokasi kustom.

Properti

Default

Kelas yang digunakan untuk menyediakan dokumentasi XML kepada pengkompilasi untuk anggota dari metadata. Implementasi kustom kelas ini harus dikembalikan dari DocumentationResolver untuk memberikan komentar dokumentasi XML dari cache atau lokasi kustom.

Metode

Equals(Object)	DocumentationProviders dibandingkan saat menentukan apakah AssemblySymbol dapat digunakan kembali. Oleh karena itu, jika beberapa instans dapat mewakili dokumentasi yang sama, sangat penting bahwa Equals (dan GetHashCode) ditimpa untuk menangkap fakta ini. Jika tidak, dimungkinkan untuk berakhir dengan beberapa AssemblySymbols untuk assembly yang sama, yang memainkan malapetaka dengan hierarki jenis.
GetDocumentationForSymbol(String, CultureInfo, CancellationToken)	Mengambil komentar dokumentasi untuk ID anggota yang diberikan.
GetHashCode()	DocumentationProviders dibandingkan saat menentukan apakah AssemblySymbol dapat digunakan kembali. Oleh karena itu, jika beberapa instans dapat mewakili dokumentasi yang sama, sangat penting bahwa GetHashCode (dan Equals) ditimpa untuk menangkap fakta ini. Jika tidak, dimungkinkan untuk berakhir dengan beberapa AssemblySymbols untuk assembly yang sama, yang memainkan malapetaka dengan hierarki jenis.