¿Incrustación de la documentación Intellisense Xml en la Asamblea?

Question

Tengo un ensamblaje que contiene documentación muy completa basada en XML, que se utiliza a través de Sandcastle para generar los archivos de ayuda para el producto. También utilizamos los archivos XML de salida para proporcionar Intellisense en Visual Studio cuando los programadores usan el ensamblaje obviamente.

Para hacer esto, parece que hemos proporcionado al usuario el ensamblaje (" assembly.dll ") y la documentación (" assembly.xml ").

¿Es posible incrustar la documentación dentro del ensamblaje, de modo que solo tendríamos que proporcionar el archivo de ensamblaje único y Visual Studio podría extraer la información? Tal vez incrustado como un recurso o algo así?

Answer 1

Desafortunadamente, deberá proporcionar ambos, ya que Visual Studio solo sabe mirar documentos XML para Intellisense.

Answer 2

Si busca en C: \ Windows \ Microsoft.NET \ Framework \ v2.0.50727, encontrará que todos los ensamblajes .net a los que hace referencia en sus aplicaciones están usando los archivos xml. Visual Studio solo proporcionará inteligencia para los ensamblajes si el archivo xml existe. Por ejemplo, si tuviera que cerrar Visual Studio, luego elimine el archivo System.Drawing.xml y luego vuelva a abrir VS, no debería haber ninguna inteligencia para ese ensamblaje. A continuación, deberá cerrar VS, volver a copiarlo y volver a abrir VS para que la inteligencia vuelva a funcionar.

Answer 3

¿me estoy perdiendo algo? Siempre comento como de costumbre (usando 3 barras o 3 marcas de verificación (vb)), uso las etiquetas xml integradas y cuando uso el ensamblaje obtengo el intellisense; rara vez utilizo un archivo xml externo.