2010-11-17 14 views
7

Suponga que tiene una biblioteca de C# con varias funciones, todo documentado con el habitual /// <summary> llenado muy bien. Hacer referencia al proyecto hará que la función y la descripción del parámetro aparezcan en la ayuda contextual de Visual Studio. Pero, ¿es posible tener este programa si no hace referencia al proyecto en sí, solo una compilación (y potencialmente algún otro archivo que tenga la documentación dentro)?¿Cómo se obtiene la documentación XML para mostrar para una biblioteca de C referenciada?

Respuesta

13

Sí existe - la biblioteca tiene que ser construido con el "archivo XML Documentación" Tickbox marcada (en las páginas de propiedades del proyecto)

alt text

Con esta opción cumplía el proceso de construcción ahora construirá una archivo XML adicional en el directorio de salida que contiene toda la documentación XML - cada vez que Visual Studio hace referencia a un conjunto de archivos que va a cargar y mostrar la documentación intelisense de este archivo XML (si se puede encontrar).

alt text

Debe distribuir este archivo junto (en el mismo directorio que) su biblioteca compilada.

Cuestiones relacionadas