La definición de goto del marco muestra comentarios, ¿se generan a partir de comentarios xml?

Question

Recientemente me sorprendió un poco descubrir que mis comentarios xml cuidadosamente elaborados no se mostraban en forma inteligente para mis colegas. Habiendo utilizado siempre los ensamblados asociados con referencias de proyectos, no me había dado cuenta de que también tenía que exportar el documento .xml para acceder a esta información.

Esto me llevó a preguntarme cómo funciona .Net framework intellisense. Si entiendo correctamente, ¿los archivos .xml deben ocultarse en algún lugar de una carpeta especial?

Pero mi pregunta principal es sobre 'Ir a la definición': si vas a la definición en un ensamblado de marco .Net, obtienes la información generada a partir de metadatos, pero también con muchos comentarios útiles, estos se generan mágicamente a partir de comentarios Xml, o ¿Alguien tuvo que escribir una macro + para convertirlos solo para la compilación? Dicho de otra manera: ¿cómo puedo obtener este efecto para mis ensamblajes?

Answer 1

¿Sus proyectos están configurados para generar la documentación XML? Solo porque agrega los comentarios al código fuente, el compilador no generará el archivo .xml a menos que se lo indiquen.

En la página de propiedades del proyecto, vaya a "Construir" pestaña y mire el " Salida " sección. Debería ver una entrada de casilla de verificación titulada " archivo de documentación XML " ;. Si el cuadro de texto que sigue a esa casilla de verificación está vacío, no está generando el archivo de documentación XML.

Una vez que obtenga el archivo de documentación XML generado, debería ver sus comentarios en la información sobre herramientas de IntelliSense. Si incluye referencias a otros proyectos como referencia de proyecto, esto debería suceder automáticamente. Si incluye referencias a ensamblajes, debe asegurarse de que el archivo xml esté en la misma ubicación que el ensamblado al que se hace referencia. (Cuando compila, debe obtener archivos xml para todos los ensamblados que los tienen en la carpeta bin / debug o bin / release respectivamente).

Para los ensamblados de .NET Framework, los archivos de documentación xml correspondientes se instalan como parte de Framework. Para .NET 2.0, 3.0 o 3.5, los archivos de documentación se encuentran en C: \ Windows \ Microsoft.NET \ Framework \ v2.0.50727 \ en (suponiendo una instalación predeterminada de Framework). Estos archivos son utilizados tanto por la información sobre herramientas de IntelliSense como por "Ir a la definición". funcionalidad en Visual Studio para mostrar esta información. No se realiza ningún procesamiento especial ni se ejecutan macros para que esto suceda. La única información que Visual Studio probablemente usa es una combinación de claves de registro para determinar la ruta correcta a los archivos de documentación.

Si bien es probable que pueda ubicar los archivos de documentación xml para sus propios ensamblados en la misma carpeta, le recomendaría que no lo haga, ya que contamina la instalación de Framework con archivos no relacionados con Framework.