Kann Implementierungsklassen XML-Kommentare von ihren implementierten Schnittstellen „erben“?

Question

Curious Frage. Ich verwende Microsoft Sandcastle Dokumentation aus den XML-Kommentare in meinem C # -Code zu generieren. Mehrere meiner Klassen implementieren Schnittstellen, die bereits Methoden haben kommentiert. Ich möchte lieber nicht duplizieren Sie die Dokumentation sowohl in der Interface-Methode und der Öffentlichkeit implementiertes Verfahren. Gibt es irgendeine Art von Tag ich verwenden kann „erben“ diese Dokumentation von der Schnittstelle?

Answer 1

Diese Funktion gibt es derzeit nicht in Visual Studio.

Sie können Tools von Drittanbietern, wie GhostDoc erhalten, die mit der Erstellung von XML-Dokumentation helfen. GhostDoc hat auch die Möglichkeit Dokumentation zu erzeugen, die „geerbt“ wurden, wie Sie zu tun versuchen.

Link: GhostDoc

Answer 2

Sie können <inheritdoc/> bei der Umsetzung hinzuzufügen.

Sie sollten einen Blick auf den folgenden Thread: Ways Schnittstelle und Implementierung Kommentare in C # synchronisieren

Answer 3

Falls jemand anderes nach einer Lösung gesucht, ich baute eine Bibliothek nachbearbeiten die XML-Dokumentationsdateien Unterstützung für einen Tag hinzuzufügen.

Weitere Informationen unter www.inheritdoc.io (kostenlos verfügbar).