¿Cuál es el archivo XML que viene junto con un archivo de ensamblaje .NET?

Question

Muchos ensamblados .NET se acompañan con un archivo XML. Por ejemplo, System.Web.WebPages.Razor.dll se reúne con System.Web.WebPages.Razor.xml que contiene lo siguiente:

<?xml version="1.0" encoding="utf-8" ?> 
<doc> 
    <assembly> 
     <name>System.Web.WebPages.Razor</name> 
    </assembly> 
    <members> 
     <member name="T:System.Web.WebPages.Razor.PreApplicationStartCode" /> 
     <member name="M:System.Web.WebPages.Razor.PreApplicationStartCode.Start" /> 
     <member name="T:System.Web.WebPages.Razor.RazorBuildProvider" /> 
     <member name="M:System.Web.WebPages.Razor.RazorBuildProvider.#ctor" /> 
     Much more elements follow... 
    </members> 
</doc> 

¿Qué es esto XML para? ¿Lo necesito en tiempo de ejecución?

Answer 1

Es el comentario de código/archivo intellisense, y lo utiliza el IDE (es decir, Visual Studio), no el tiempo de ejecución, es de donde provienen todas las descripciones ampliadas de método/parámetro/tipo, etc.

No necesita implementarlo con su binario, pero tampoco daña. También es totalmente opcional en el IDE, simplemente: intellisense será menos informativo sin él (solo mostrará los nombres y tipos, etc.), no las descripciones más detalladas del método.

En su propia biblioteca, use la sintaxis /// para escribir sus propios comentarios de código y habilite la generación de archivos XML en project-properties.

Answer 2

Esta es la documentación XML para ese ensamblaje. Esto solo se usa para Intellisense en VisualStudio. Consulte this answer para más detalles.