c# - valid - El resumen no se muestra en el ensamblaje si se agrega como referencia

sandcastle visual studio

Question

Creé una ''Biblioteca de clases'' en C #, que tiene muchas funciones con resumen (comentarios de documentación XML).

Por ejemplo

///<summary>
///Adds the two numbres
///</summary>
public void Add()
{
    //statements
}

si utilizo la función en el mismo espacio de nombres, se muestra el resumen, pero si lo agregué como referencia en algún espacio de trabajo ohter (solución) no se muestra el resumen.

¿Cómo hacer que sea visible en otras soluciones si se agrega como referencia y wat puede ser la razón para esto?

Answer 1

1. Vaya al explorador de soluciones de su código fuente. Haga clic derecho sobre el nombre del proyecto y vaya a las propiedades .
2. vaya a la pestaña Crear si está usando c # y seleccione el archivo de documentación Xml de la casilla de verificación.
3. Cuando construyes tu código fuente, el archivo Xml se generará en la ubicación donde está tu dll.
4. mientras copia su dll a la solución, copie el archivo xml y péguelo en el contenedor de su solución de destino.

Answer 2

Cuando compila clases que tienen comentarios xml, normalmente se crea un archivo .xml. (verifique las opciones en Visual Studio)

Cuando agrega una referencia a dicho ensamblaje, asegúrese de que el archivo XML esté presente. La documentación no está contenida dentro del ensamblado sino dentro del archivo xml.

Answer 3

Necesita generar documentación XML para el ensamblado (un archivo llamado myassembly.xml) y copiarlo junto con su .dll, donde sus otros proyectos lo mencionan. Consulte esta página en MSDN para obtener instrucciones.