XmlDocumentationProvider 类

定义

一个类,用于向编译器提供来自 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
继承
XmlDocumentationProvider

构造函数

XmlDocumentationProvider()

一个类,用于向编译器提供来自 XML 文档源的元数据的成员的 XML 文档。

方法

CreateFromBytes(Byte[])

创建一个 XmlDocumentationProvider 表示 XML 文档数据的字节。

CreateFromFile(String)

从 XML 文档文件创建一个 XmlDocumentationProvider

Equals(Object)

确定是否可以重复使用 AssemblySymbol 时,比较 DocumentationProviders。 因此,如果多个实例可以表示相同的文档,则必须重写 Equals (和 GetHashCode) 来捕获此事实。 否则,对于同一程序集,最终可能有多个 AssemblySymbols,该程序集对类型层次结构进行破坏。

(继承自 DocumentationProvider)
GetDocumentationForSymbol(String, CultureInfo, CancellationToken)

一个类,用于向编译器提供来自 XML 文档源的元数据的成员的 XML 文档。

GetHashCode()

确定是否可以重复使用 AssemblySymbol 时,比较 DocumentationProviders。 因此,如果多个实例可以表示相同的文档,则必须重写 GetHashCode (和 Equals) 来捕获此事实。 否则,对于同一程序集,最终可能有多个 AssemblySymbols,该程序集对类型层次结构进行破坏。

(继承自 DocumentationProvider)
GetSourceStream(CancellationToken)

获取 XML 文档的源流。

适用于