Une façon de copier des commentaires XML à partir d'un ensemble d'API à un autre ensemble similaire d'API?

Question

Supposons que dans Visual Studio J'ai un nouveau projet qui contient quelques-unes des mêmes API à partir d'un projet plus ancien, et je voudrais copier la documentation xml vers le nouveau. Est-il possible que je peux le faire sans manuellement les copier-coller un par un?

Answer 1

Je maintiens un projet open-source qui implémente une fonctionnalité favorisant l'accès aux commentaires programatic XML document. Voir Jolt.NET pour plus d'informations sur le projet, et plus précisément, " Interrogation XML Doc Commentaires" pour la documentation de cette fonction.

Voici un exemple de la façon d'utiliser la bibliothèque pour mettre en œuvre ce que vous recherchez.

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");
}

Dans cet exemple, je suppose que vous voulez copier les commentaires doc des types similaires dans deux ensembles. Si vous devez limiter la copie plus aux membres de spécifiques, vous pouvez également accomplir cela avec la bibliothèque, mais vous aurez besoin de mettre en œuvre la même logique de méthode de filtrage.

Answer 2

Je n'ai pas entendu parler d'un tel outil. La seule chose que je sais de c'est à distance similaire est la capacité de ReSharper copier commentaires XMLDoc des classes de base pour les classes dérivées.