XmlDocumentationProvider Kelas

Definisi

Ruang nama:

Microsoft.CodeAnalysis

Rakitan:

Microsoft.CodeAnalysis.Workspaces.dll

Paket:

Microsoft.CodeAnalysis.Workspaces.Common v4.9.2

Source:

XmlDocumentationProvider.cs

Kelas yang digunakan untuk menyediakan dokumentasi XML kepada pengkompilasi untuk anggota dari metadata dari sumber dokumen 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

Warisan

Object

DocumentationProvider

XmlDocumentationProvider

Konstruktor

XmlDocumentationProvider()

Kelas yang digunakan untuk menyediakan dokumentasi XML kepada pengkompilasi untuk anggota dari metadata dari sumber dokumen XML.

Metode

CreateFromBytes(Byte[])	Membuat byte dari yang XmlDocumentationProvider mewakili data dokumentasi XML.
CreateFromFile(String)	XmlDocumentationProvider Membuat dari file dokumentasi XML.
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 rakitan yang sama, yang memainkan malapetaka dengan hierarki jenis. (Diperoleh dari DocumentationProvider)
GetDocumentationForSymbol(String, CultureInfo, CancellationToken)	Kelas yang digunakan untuk menyediakan dokumentasi XML kepada pengkompilasi untuk anggota dari metadata dari sumber dokumen XML.
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 rakitan yang sama, yang memainkan malapetaka dengan hierarki jenis. (Diperoleh dari DocumentationProvider)
GetSourceStream(CancellationToken)	Mendapatkan aliran sumber untuk dokumen XML.