c# - tag - visual studio xml documentation to html




Übernehmen von XML-Kommentaren von Schnittstellen in C# (4)

Ich habe mich gefragt, ob jemand weiß, wie man einen Interface-XML-Kommentar mit einer Implementierung verknüpft. Das Problem ist, dass ich möchte, dass die Basiskommentare zuerst von meiner Schnittstelle kommen. Beispiel:

interface myinterface {

       /// <summary>
       /// Does something.
       /// </summary>
       void method1(string foo);

}

und dann ist die Implementierung:

public class myclass : myinterface {


       public void method1(string foo) {
             //do something...
       }
}

Also, wenn ich nach der Instanziierung des Objekts mit der Maus über die Methode fahre:

myclass foo = new myclass();
foo.method1("do something");

Wie kann ich die Kommentare im Hover-Popup anzeigen lassen? Gibt es eine Möglichkeit, die Kommentare der Benutzeroberfläche mit der Implementierung zu verknüpfen? Ich weiß, dass es einen Weg in Java gibt, aber ich kann keine Lösung für C # finden.

Vielen Dank


Das Verknüpfen von XML-Kommentaren ist IMHO nicht möglich, aber Sie könnten ein Tool wie GhostDoc um den XML-Kommentar von Ihrer Schnittstelle / Basisklasse in die Implementierung / abgeleitete Klasse zu kopieren.


Ich habe ein Befehlszeilentool erstellt, um die XML-Dokumentationsdateien nachzufüllen und Unterstützung für das <inheritdoc /> - Tag hinzuzufügen.

Es hilft zwar nicht mit Intellisense im Quellcode, erlaubt aber, die modifizierten XML-Dokumentationsdateien in ein NuGet-Paket aufzunehmen und arbeitet daher mit Intellisense in referenzierten NuGet-Paketen.

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


XMLDoc definiert ein Tag <include /> zum Einfügen von Kommentaren aus einer anderen Datei, die es seit Visual Studio 2003 gibt. Der größte Nachteil ist, dass die referenzierte Datei eine Datei sein sollte, die nur XMLDoc-Dokumentation enthält, keine andere Quelldatei.

Weitere Informationen finden Sie auf der MSDN-Seite .


http://blog.x-tensive.com/2008/02/fixml.html

Es ist ein Postprozessor, der bestimmte zusätzliche Optionen enthält, bei denen das ursprüngliche Dokumentationssystem fehlt.

Von der Website:

Kurze Zusammenfassung:

FiXml ist ein Postprozessor der XML-Dokumentation, die von C # \ Visual Basic.Net erstellt wurde. Es behandelt einige der ärgerlichsten Fälle im Zusammenhang mit dem Schreiben von XML-Dokumentation in diesen Sprachen: - Keine Unterstützung für das Erben der Dokumentation von der Basisklasse oder Schnittstelle. Dh eine Dokumentation für jedes überschriebene Mitglied sollte von Grund auf neu geschrieben werden, obwohl es normalerweise wünschenswert ist, zumindest den Teil davon zu erben. - Keine Unterstützung für das Einfügen häufig verwendeter Dokumentationsvorlagen wie "Dieser Typ ist Singleton - verwenden Sie seine Eigenschaft, um die einzige Instanz davon zu erhalten" oder "Initialisiert eine neue Instanz der Klasse".





visual-studio-2010