Ein Weg, um XML-Kommentare aus einer Reihe von APIs auf einem anderen ähnlichen Satz von APIs zu kopieren?

Question

Angenommen, in Visual Studio ich ein neues Projekt haben, die zum Teil die gleichen APIs von einem älteren Projekt enthält, und ich möchte die XML-Dokumentation auf die neue kopieren. Gibt es eine Möglichkeit, ich kann dies tun, ohne manuell kopieren-einfügen sie eins nach dem anderen?

Answer 1

ich ein Open-Source-Projekt halte, dass Geräte eine Funktion programatic Zugriff auf XML-Dokument Kommentare zu unterstützen. Siehe Jolt.NET für weitere Informationen über das Projekt, und zwar " Querying XML Doc Kommentare " für die Dokumentation für diese Funktion.

Hier ist ein Beispiel dafür, wie die Bibliothek verwenden, um das umzusetzen, was Sie suchen.

using Jolt;
using System.Xml.Linq;

void CopyXmlDocComments(Assembly sourceAssembly)
{
    XDocument newDocComments = new XDocument();
    XmlDocCommentReader reader = new XmlDocCommentReader(sourceAssembly);

    foreach(Type t in sourceAssembly.GetTypes())  // implement type filter here
    {
        newDocComments.Add(reader.GetComments(t));
    }

    newDocComments.Save("newAssemblyName.dll.xml");
}

In diesem Beispiel gehe ich davon aus, dass Sie die doc Kommentare der ähnlichen Typen in zwei Baugruppen kopieren möchten. Wenn Sie das Kopieren weiter zu Mitgliedern beschränken müssen, können Sie auch erreichen, dass mit der Bibliothek, wenn Sie die Methode-Filterung Logik selbst implementieren müssen.

Answer 2

Ich habe nicht von einem solchen Werkzeug gehört. Das einzige, was ich weiß, das ist entfernt ähnlich ist ReSharper Fähigkeit xmldoc Kommentare von Basisklassen abgeleiteten Klassen zu kopieren.