Können Implementierungsklassen XML-Kommentare von ihren implementierten Schnittstellen "erben"?

Question

Neugierige Frage. Ich verwende Microsoft Sandcastle, um Dokumentation aus den XML-Kommentaren in meinem C# -Code zu generieren. Einige meiner Klassen implementieren Interfaces, die bereits Methoden kommentiert haben. Ich möchte die Dokumentation nicht sowohl in der Schnittstellenmethode als auch in der öffentlich implementierten Methode duplizieren. Gibt es eine Art von Tag, den ich verwenden kann, um diese Dokumentation von der Schnittstelle zu "erben"?

Answer 1

Diese Funktion ist derzeit in Visual Studio nicht vorhanden.

Sie können Tools von Drittanbietern wie GhostDoc verwenden, die beim Erstellen von XML-Dokumentation helfen. GhostDoc hat auch die Möglichkeit, Dokumentation zu erzeugen, die "vererbt" wurde, wie Sie es versuchen.

-Link: GhostDoc

Answer 2

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

Sie sollten einen Blick auf den folgenden Thread: Ways to synchronize interface and implementation comments in C#

Answer 3

Falls jemand anderes nach einer Lösung gesucht, ich baute eine Bibliothek, um Post-Prozess die XML-Dokumentationsdateien Unterstützung für eine < inheritdoc hinzufügen/> tag.

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