DocumentationProvider Klasse
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Eine Klasse, die verwendet wird, um xml-Dokumentation für den Compiler für Elemente aus Metadaten bereitzustellen. Eine benutzerdefinierte Implementierung dieser Klasse sollte von einer DocumentationResolver zurückgegeben werden, um XML-Dokumentationskommentare aus benutzerdefinierten Caches oder Speicherorten bereitzustellen.
public ref class DocumentationProvider abstractpublic abstract class DocumentationProvidertype DocumentationProvider = classPublic MustInherit Class DocumentationProvider- Vererbung
-
DocumentationProvider
- Abgeleitet
Konstruktoren
| DocumentationProvider() |
Eine Klasse, die verwendet wird, um xml-Dokumentation für den Compiler für Elemente aus Metadaten bereitzustellen. Eine benutzerdefinierte Implementierung dieser Klasse sollte von einer DocumentationResolver zurückgegeben werden, um XML-Dokumentationskommentare aus benutzerdefinierten Caches oder Speicherorten bereitzustellen. |
Eigenschaften
| Default |
Eine Klasse, die verwendet wird, um xml-Dokumentation für den Compiler für Elemente aus Metadaten bereitzustellen. Eine benutzerdefinierte Implementierung dieser Klasse sollte von einer DocumentationResolver zurückgegeben werden, um XML-Dokumentationskommentare aus benutzerdefinierten Caches oder Speicherorten bereitzustellen. |
Methoden
| Equals(Object) |
DocumentationProviders werden verglichen, wenn sie bestimmen, ob ein AssemblySymbol wiederverwendet werden kann. Wenn daher mehrere Instanzen dieselbe Dokumentation darstellen können, ist es zwingend erforderlich, dass Equals (und GetHashCode) außer Kraft gesetzt werden, um diese Tatsache zu erfassen. Andernfalls ist es möglich, mit mehreren AssemblySymbols für dieselbe Assembly zu enden, die mit der Typhierarchie havociert. |
| GetDocumentationForSymbol(String, CultureInfo, CancellationToken) |
Ruft einen Dokumentationskommentar für die angegebene Member-ID ab. |
| GetHashCode() |
DocumentationProviders werden verglichen, wenn sie bestimmen, ob ein AssemblySymbol wiederverwendet werden kann. Wenn daher mehrere Instanzen dieselbe Dokumentation darstellen können, ist es zwingend erforderlich, dass GetHashCode (und Equals) außer Kraft gesetzt werden, um diese Tatsache zu erfassen. Andernfalls ist es möglich, mit mehreren AssemblySymbols für dieselbe Assembly zu enden, die mit der Typhierarchie havociert. |
