Una manera de copiar los comentarios XML a partir de un conjunto de APIs a otro conjunto similar de API?

Question

Supongamos que en Visual Studio Tengo un nuevo proyecto que contiene algunas de las mismas API de un proyecto mayor, y me gustaría copiar la documentación XML a la nueva. ¿Hay alguna manera de hacer esto sin manualmente copiar y pegar uno por uno?

Answer 1

Me mantener un proyecto de código abierto que implementa una característica apoyar el acceso programático a los comentarios de documentos XML. Ver Jolt.NET para obtener más información sobre el proyecto, y en concreto, " Consulta XML Doc Comentarios " para la documentación para esta función.

Este es un ejemplo de cómo utilizar la biblioteca para poner en práctica lo que busca.

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

En este ejemplo, estoy asumiendo que desea copiar los comentarios de documentación de los tipos similares en dos asambleas. Si necesita restringir la copia adicional a miembros específicos, también se puede lograr eso con la biblioteca, aunque se tenga que aplicar la lógica del método de filtrado de sí mismo.

Answer 2

No he oído hablar de ninguna de estas herramientas. La única cosa que sé de eso es remotamente similar es la capacidad de ReSharper para copiar los comentarios xmlDoc de clases base a las clases derivadas.