Verwendung von XML-Dokumentationsdateien

Bei Verwendung einer externen Assembly, die mit einer XML-Dokumentationsdatei geliefert wird, wie bekomme ich Visual Studio, um es zu finden?Verwendung von XML-Dokumentationsdateien
Wenn es eine XML-Dokumentationsdatei gibt, gibt es ein Programm oder eine XML-Transformationsdatei oder etwas, das ich verwenden kann, um es auf eine nette Weise zu betrachten? Nicht unbedingt so komplex wie das Msdn Dokumentation Betrachter Dingen, aber zumindest etwas schöner als das reine xml ...

2009-03-20 Svish

1: Sie einfach es im selben Ordner wie triefender dll

2: braucht man es beibehalten werden? Für die "Live" -Benutzung können Sie sowohl die VS IDE als auch "reflector" die Dokumentation überprüfen (gegen die Typen/members/etc). Es gibt Werkzeuge, um es zu transformieren, aber ich habe mich nie darum gekümmert. Sandcastle kann einen Blick wert sein, aber es war nie nett zu mir; -p

Quelle

2009-03-20 10:41:08

Ich habe versucht, es in den gleichen Ordner zu legen, aber es will es nicht abholen scheint es. Ich bekomme immer noch keine Dokumentation. – Svish

Die Dateien müssen Foo.Bar.dll und Foo.Bar.xml (zum Beispiel) sein; Sind Sie sicher, dass Sie von diesem Ort aus auf die DLL verweisen? Und bist du sicher, dass es eine Kommentardatei ist? –

Scheint wie ich VS neu starten musste, damit es funktioniert ... gibt es einen Befehl, um Dokumentation neu zu erstellen/neu zu lesen oder etwas vielleicht? – Svish

Antwort auf Ihre erste Frage: die xml sollte die gleichen Namen wie die Assembly hat und seine direkt neben zu ihm. Wenn Sie also eine Assembly namens "Svish.dll" haben, sollte Ihre Dokumentationsdatei "Svish.xml" lauten und sich im selben Verzeichnis befinden.

Quelle

2009-03-20 10:40:17

1) Die Dokumentationsdatei muss den gleichen Namen wie der Assemblyname mit der hinzugefügten Erweiterung '.xml' haben, und in derselben liegen Verzeichnis als die entsprechende Assembly. So haben Sie zum Beispiel eine 'MyCompany.MyNamespace.dll' und eine 'MyCompany.MyNamespace.dll.xml' Datei im selben Verzeichnis.

2) NDOC kann einige Formate der Dokumentation generieren.

Quelle

2009-03-20 10:42:01 Razzie

In den Beispielen, die ich gesehen habe und die für mich funktionierten, war es wie in Marc Gravells Antwort. Das heißt: 'MyCompany.MyNamespace.xml' nicht' MyCompany.MyNamespace.dll.xml'. –

Zu 2: Sie sollten in der Lage sein, eine "schöne Version" der Dokumentation mit dem Objektbrowser (Ansicht> Objektbrowser (Strg W + J)) anzusehen und dann zu der Klasse zu navigieren, die Sie überprüfen möchten die Dokumentation. Ich habe den Objektbrowser verwendet, um meine eigene Dokumentation zu überprüfen, da sie leserfreundlicher ist als die XML-Dateien oder die Kommentare.

Quelle

2014-11-26 08:17:41

Antwort

Verwandte Themen