comentarios Heredar XML de interfaces en C#

Question

me preguntaba si alguien sabe cómo vincular un comentario interfaz XML a una aplicación. El problema es que quiero que los comentarios base provengan primero de mi interfaz. Ejemplo:

interface myinterface { 

     /// <summary> 
     /// Does something. 
     /// </summary> 
     void method1(string foo); 

} 

y después de la aplicación es:

public class myclass : myinterface { 


     public void method1(string foo) { 
      //do something... 
     } 
} 

Así que ahora si se ciernen sobre el método con mi ratón después de instancia del objeto:

myclass foo = new myclass(); 
foo.method1("do something"); 

cómo puedo hacer que la los comentarios aparecen en el elemento emergente emergente? ¿Hay alguna forma en que pueda vincular los comentarios de la interfaz con la implementación? Sé que hay una forma en Java, pero no puedo encontrar la solución para C#.

Gracias

Answer 1

XML Vinculación de los comentarios es mi humilde opinión no es posible, pero se puede utilizar una herramienta como GhostDoc para copiar el comentario XML de su interfaz/BaseClass a la/clase derivada aplicación.

Answer 2

Si utiliza GhostDoc que ayuda mucho con el "transporte" de la documentación de interfaces para el código de la aplicación.

Answer 3

http://blog.x-tensive.com/2008/02/fixml.html

Es un post-procesador que tiene ciertas opciones adicionales en los que falta el sistema de documentación original.

Desde el sitio web:

Breve resumen:

FIXML es post-procesador de documentos XML producido por C# \ Visual Basic.Net. Aborda algunos de los casos más molestos relacionados con la escritura de documentación XML en estos idiomas: - No admite la herencia de la documentación de la clase base o la interfaz. Es decir. una documentación para cualquier miembro anulado se debe escribir desde cero, aunque normalmente es bastante deseable heredar al menos una parte de ella. - No admite la inserción de plantillas de documentación comúnmente utilizadas, como "Este tipo es singleton: use su propiedad para obtener la única instancia de este." O incluso "Inicializa una nueva instancia de clase"

Answer 4

XMLDoc define una etiqueta <include /> para incluir comentarios de otro archivo que ha existido desde Visual Studio 2003. La advertencia más importante es que el archivo al que se hace referencia debe ser un archivo que contenga solo documentación XMLDoc, no otro archivo fuente.

Ver the MSDN page para más detalles.

Answer 5

Creé una herramienta de línea de comandos para procesar los archivos de documentación XML agregando soporte para la etiqueta < inheritdoc/>.

Si bien no ayuda con Intellisense en el código fuente, sí permite que los archivos de documentación XML modificados se incluyan en un paquete NuGet y, por lo tanto, funciona con Intellisense en los paquetes NuGet a los que se hace referencia.

Ver www.inheritdoc.io para obtener más información (versión libre disponible).