remarks - what are two ways you can compile xml tags and documentation into an xml file

Incrustar la documentación de Intellisense Xml en ensamblaje?

Question

Tengo un ensamblado que contiene una 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 apropiado en Visual Studio cuando los programadores usan el ensamblaje obviamente.

Para hacer esto, parece que tenemos que suministrar al usuario el ensamblado ("assembly.dll") y la documentación ("assembly.xml").

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

Answer 1

¿Me estoy perdiendo de algo? Siempre comento como de costumbre (usando 3 barras diagonales o 3 marcas de graduación (vb)), uso las etiquetas integradas xml y cuando uso el ensamblaje obtengo el intellisense - rara vez uso un archivo extremal xml.

Answer 2

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

Answer 3

Si busca C: / Windows / Microsoft.NET / Framework / v2.0.50727, encontrará que todos los ensamblados .net a los que puede hacer referencia en sus aplicaciones utilizan los archivos xml. Visual Studio solo proporcionará intellisense para ensamblajes si el archivo xml existe. Por ejemplo, si tuviera que cerrar Visual Studio, entonces elimine el archivo System.Drawing.xml y luego vuelva a abrir VS, no debería haber ningún intellisense para ese ensamblaje. Debería cerrar VS, copiarlo nuevamente, y luego volver a abrir VS para que el intellisense funcione nuevamente.