Qual è il file XML che viene fornito con un file di assembly .NET?

Question

Molti assembly .NET sono accompagnati da un file XML. Ad esempio, System.Web.WebPages.Razor.dll viene insieme con System.Web.WebPages.Razor.xml che contiene quanto segue:

<?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> 

Che cos'è questo XML per? Ne ho bisogno in runtime?

Answer 1

È il codice commenti/file intellisense ed è utilizzato dall'IDE (ad esempio Visual Studio), non dal runtime - è da dove provengono tutte le descrizioni del metodo/parametro/tipo esteso ecc.

Non è necessario distribuirlo con il file binario, ma non fa nulla di male. È anche del tutto opzionale nell'IDE - solo: intellisense sarà meno informativo senza di esso (mostrerà solo nomi e tipi, ecc. - non le descrizioni più dettagliate dei metodi).

Nella propria libreria, utilizzare la /// sintassi per scrivere i propri commenti di codice e abilitare la generazione di file XML nelle proprietà del progetto.

Answer 2

Questa è la documentazione XML per tale assembly. Questo è usato solo per Intellisense in VisualStudio. Per ulteriori dettagli, consultare this answer.