2011-06-25 8 views
33

He creado una "Biblioteca de clases" en C#, que tiene muchas funciones con un resumen (comentarios de documentación XML).El resumen no se muestra en el ensamblado si se agrega como referencia

Por ejemplo

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

si uso la función en el mismo espacio de nombres, su muestra el resumen, pero si he añadido como referencia en algunos espacio de trabajo ohter (solución) su no muestra el resumen.

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

+1

[probar este] (http://stackoverflow.com/questions/1329338/xml-comments-not-showing-on-vb-net) –

Respuesta

33

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 this page in MSDN para obtener instrucciones.

+2

¿Cómo es que los ensamblados de .NET Framework Proporcionar Intellisense entonces? también otros controles de terceros como telerik y Ajax Control Toolkit gratuito – Deeptechtons

+0

tuve que reiniciar VS para aplicar este cambio. – BornToCode

2

Cuando compila las clases que tienen xml comment, normalmente se crea un archivo .xml. (compruebe 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.

30
  1. Vaya al explorador de soluciones de su código fuente. Haga clic con el botón derecho en el nombre del proyecto y vaya a las propiedades .
  2. vaya a la pestaña Compilación si está utilizando C# y seleccione la casilla de verificación Xml archivo de documentación.
  3. Cuando construye su código fuente, el archivo Xml se generará en la ubicación donde está su 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.
+1

Solo como recordatorio, hay configuraciones separadas para depurar y liberar. Puede marcar/desmarcar "Archivo de documentación Xml" para ambos por separado en la configuración de su proyecto. –

Cuestiones relacionadas