studio - Heredar comentarios XML de interfaces en C#

generar documentacion visual studio 2017

Question

Me preguntaba si alguien sabe cómo vincular un comentario xml de interfaz a una implementació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 luego la implementación es:

public class myclass : myinterface {


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

Así que ahora si sobrevivo el método con mi mouse después de crear una instancia del objeto:

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

¿Cómo puedo hacer que los comentarios aparezcan en la ventana 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

Creé una herramienta de línea de comando para postprocesar 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.

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

Answer 2

Si usa GhostDoc , ayuda mucho con "transportar" la documentación de las interfaces al código de implementación.

Answer 3

Vincular comentarios XML no es posible en mi humilde opinión, pero podría usar una herramienta como GhostDoc para copiar el comentario XML de su interfaz / clase base a la implementación / clase derivada.

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 solo contenga documentación XMLDoc, no otro archivo fuente.

Vea la página de MSDN para más detalles.

Answer 5

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

Es un postprocesador que tiene ciertas opciones adicionales donde falta el sistema de documentación original.

Desde el sitio web:

Breve resumen:

FiXml es un post-procesador de documentación 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 de uso común, como "Este tipo es singleton: use su propiedad para obtener la única instancia de este." O incluso "Inicializa una nueva instancia de clase".