DocumentationProvider 클래스

정의

네임스페이스:

Microsoft.CodeAnalysis

어셈블리:

Microsoft.CodeAnalysis.dll

패키지:

Microsoft.CodeAnalysis.Common v4.12.0

Source:

DocumentationProvider.cs

메타데이터의 멤버에 대한 XML 설명서를 컴파일러에 제공하는 데 사용되는 클래스입니다. 사용자 지정 캐시 또는 위치에서 XML 설명서 주석을 제공하려면 DocumentationResolver에서 이 클래스의 사용자 지정 구현을 반환해야 합니다.

public ref class DocumentationProvider abstract

public abstract class DocumentationProvider

type DocumentationProvider = class

Public MustInherit Class DocumentationProvider

상속

Object

DocumentationProvider

파생

Microsoft.CodeAnalysis.XmlDocumentationProvider

생성자

DocumentationProvider()

메타데이터의 멤버에 대한 XML 설명서를 컴파일러에 제공하는 데 사용되는 클래스입니다. 사용자 지정 캐시 또는 위치에서 XML 설명서 주석을 제공하려면 DocumentationResolver에서 이 클래스의 사용자 지정 구현을 반환해야 합니다.

속성

Default

메타데이터의 멤버에 대한 XML 설명서를 컴파일러에 제공하는 데 사용되는 클래스입니다. 사용자 지정 캐시 또는 위치에서 XML 설명서 주석을 제공하려면 DocumentationResolver에서 이 클래스의 사용자 지정 구현을 반환해야 합니다.

메서드

Equals(Object)	DocumentationProviders는 AssemblySymbol을 다시 사용할 수 있는지 여부를 결정할 때 비교됩니다. 따라서 여러 인스턴스가 동일한 설명서를 나타낼 수 있는 경우 이 사실을 캡처하려면 Equals(및 GetHashCode)를 재정의해야 합니다. 그렇지 않으면 동일한 어셈블리에 대해 여러 AssemblySymbols로 끝날 수 있습니다. 이 어셈블리는 형식 계층 구조에 혼란을 줍니다.
GetDocumentationForSymbol(String, CultureInfo, CancellationToken)	지정된 멤버 ID에 대한 설명서 주석을 가져옵니다.
GetHashCode()	DocumentationProviders는 AssemblySymbol을 다시 사용할 수 있는지 여부를 결정할 때 비교됩니다. 따라서 여러 인스턴스가 동일한 설명서를 나타낼 수 있는 경우 GetHashCode(및 Equals)를 재정의하여 이 사실을 캡처해야 합니다. 그렇지 않으면 동일한 어셈블리에 대해 여러 AssemblySymbols로 끝날 수 있습니다. 이 어셈블리는 형식 계층 구조에 혼란을 줍니다.