Incorporare la documentazione Intellisense Xml in Assembly?

Question

Ho un assembly che contiene una documentazione molto dettagliata basata su XML, che viene utilizzata attraverso Sandcastle per generare i file della guida per il prodotto. Utilizziamo anche i file XML di output per fornire Intellisense corretto in Visual Studio quando i programmatori usano l'assembly ovviamente.

Per fare ciò, sembra che sia necessario fornire all'utente l'assemblaggio (" assembly.dll ") e la documentazione (" assembly.xml ").

È in qualche modo possibile incorporare la documentazione all'interno dell'assembly, quindi dovremmo fornire solo il singolo file assembly e Visual Studio sarebbe in grado di estrarre le informazioni? Forse incorporato come una risorsa o qualcosa del genere?

Answer 1

Sfortunatamente dovrai fornire entrambi poiché Visual Studio sa solo guardare i documenti XML per Intellisense.

Answer 2

Se cerchi C: \ Windows \ Microsoft.NET \ Framework \ v2.0.50727 scoprirai che tutti gli assembly .net a cui potresti fare riferimento nelle tue applicazioni utilizzano i file xml. Visual Studio fornirà intellisense per gli assembly se esiste il file xml. Ad esempio, se si dovesse chiudere Visual Studio, quindi rimuovere il file System.Drawing.xml e quindi riaprire VS, non dovrebbe esserci alcun intellisense per quell'assemblaggio. Dovresti quindi chiudere VS, copiarlo di nuovo e quindi riaprire VS affinché l'intellisense funzioni di nuovo.

Answer 3

Mi sto perdendo qualcosa? Commento sempre come al solito (usando 3 barre o 3 segni di spunta (vb)), uso i tag xml integrati e quando uso l'assembly ottengo l'intellisense - uso raramente un file xml esterno.