Un modo per copiare i commenti XML da un set di API per un'altra serie simile di API?

Question

Si supponga che in Visual Studio Ho un nuovo progetto che contiene alcune delle stesse API di un progetto più grande, e vorrei copiare la documentazione XML sopra a quello nuovo. C'è un modo che io possa fare questo senza copiare manualmente-incollando uno per uno?

Answer 1

I mantenere un progetto open-source che implementa una funzione di supporto l'accesso programmatico ai commenti documento XML. Vedere Jolt.NET Per ulteriori informazioni sul progetto, e in particolare, " Interrogazione XML Doc Commenti " per la documentazione per questa funzione.

Ecco un esempio di come utilizzare la libreria per implementare ciò che si sta cercando.

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 questo esempio, io parto dal presupposto che si desidera copiare i commenti di documentazione dei tipi simili in due assemblee. Se è necessario vincolare la copia di più a membri specifici, si può anche realizzare che con la libreria, anche se sarà necessario implementare la logica metodo di filtraggio-te.

Answer 2

Non ho sentito parlare di un tale strumento. L'unica cosa che so di che è lontanamente simile è la capacità di ReSharper di copiare i commenti xmlDoc da classi base alle classi derivate.