Intellisense non mostra XMLDOC per DLL di riferimento

Question

Sto utilizzando VS-2010 Ultimate versione 10.0.30319.1 RTMRel (dalla casella di informazioni).

Ho scritto una libreria di classi con un sacco di codice XMLDOC (imho). Per ragioni a cui non intendo entrare quando uso questa libreria in varie soluzioni, il progetto stesso non è incluso (come nella soluzione del tasto destro, aggiungi un progetto esistente ...); invece, aggiungiamo semplicemente un riferimento alla DLL come se fosse una libreria di terze parti.

Nella soluzione che contiene la libreria, intellisense funziona normalmente e ottengo il vantaggio completo di XMLDOC. Sfortunatamente, non è dove lo userò!

In altre soluzioni, in cui la libreria è solo una DLL di riferimento, ottengo intellisense, ma nessun XMLDOC. Mentre la mia biblioteca è abbastanza comprensibile da usare senza le rotelle di supporto, mi chiedo perché questo sia e se ci sia qualcosa che posso fare al riguardo.

Paragrafo molto ignorabile: spero che il sospetto piuttosto cinico che ho attraversato la mia mente sia infondato come penso che sia - cioè, che M $ potrebbe aver "bloccato" questa funzionalità in qualche modo per vendergli l'accesso a sviluppatori di librerie di terze parti ... Suppongo che uno possa fare fare qualcosa come richiedere alla DLL di essere firmata da una particolare chiave e offrire qualche servizio for-pay online dove le persone potrebbero firmare le loro DLL con questa chiave per abilitare la funzionalità, ma dato quanto è prezioso per la piattaforma avere sviluppatori di librerie e componenti di terze parti, sembra improbabile che qualcuno dovrebbe preoccuparsi.

Quindi, qualcuno ha qualche consiglio da condividere su come farlo funzionare? Mi piacerebbe che XMLDOC si visualizzasse in intellisense ogni volta che utilizzo la cosa, indipendentemente da come. :)

Answer 1

L'assembly non contiene la documentazione di commento effettiva. È necessario generare un file XML che contenga tutta la documentazione.

entra nella tua Impostazioni progetti, nella scheda Costruisci Check "Documentazione File XML":

Ora, quando si compila il progetto, un file XML bella sarà prodotto contenente la documentazione.

Nell'altro progetto, è necessario fare riferimento alla DLL e assicurarsi che l'XML abbia lo stesso nome dell'assembly con un'estensione XML anziché DLL e si trovi nella stessa directory della DLL di riferimento. Per esempio:

Assemblea: MyProject.dll

XML: MyProject.xml

Si può imparare di più su documentazione XML at MSDN.