La definizione di goto del framework mostra i commenti, sono generati dai commenti XML?

Question

Di recente sono stato leggermente sorpreso di scoprire che i miei commenti XML accuratamente elaborati non venivano visualizzati in intellisense per i miei colleghi. Avendo sempre usato gli assiemi associati con riferimenti a progetti, non mi ero reso conto che dovevi esportare anche il documento .xml per accedere a queste informazioni.

Questo mi ha portato a chiedermi come funziona l'intellisense del framework .Net. Se ho capito bene, i file .xml devono essere nascosti da qualche parte in una cartella speciale?

Ma la mia domanda principale riguarda "Vai a definizione" - se vai a definizione su un assembly framework .Net, ottieni le informazioni generate dai metadati - ma anche con molti commenti utili - sono magicamente generate dai commenti Xml, o qualcuno ha dovuto scrivere una macro + per convertirli solo per la build? In altre parole: come posso ottenere questo effetto per le mie assemblee?

Answer 1

I tuoi progetti sono configurati per generare la documentazione XML? Solo perché aggiungi i commenti al codice sorgente, il compilatore non genererà il file .xml a meno che non venga detto.

Nella pagina delle proprietà del progetto, vai a " Build " scheda e guarda il " Output " sezione. Dovresti visualizzare una casella di controllo intitolata "File di documentazione XML". Se la casella di testo che segue quella casella è vuota, non stai generando il file di documentazione XML.

Una volta generato il file di documentazione XML, dovresti vedere i tuoi commenti nelle descrizioni dei comandi di IntelliSense. Se si includono riferimenti ad altri progetti come riferimento del progetto, ciò dovrebbe avvenire automaticamente. Se si includono riferimenti ad assiemi, è necessario assicurarsi che il file xml si trovi nella stessa posizione dell'assembly di riferimento. (Quando si genera, è necessario ottenere i file XML per tutti gli assembly che li hanno rispettivamente nella cartella bin / debug o bin / release.)

Per gli assembly .NET Framework stessi, i file di documentazione xml corrispondenti vengono installati come parte di Framework. Per .NET 2.0, 3.0 o 3.5 i file di documentazione si trovano in C: \ Windows \ Microsoft.NET \ Framework \ v2.0.50727 \ en (presupponendo un'installazione predefinita di Framework). Questi file vengono utilizzati sia dalle descrizioni dei comandi IntelliSense sia da " Vai alla definizione " funzionalità in Visual Studio per visualizzare queste informazioni. Non esiste alcuna elaborazione speciale che viene eseguita o l'esecuzione di macro per consentire che ciò accada. Le uniche informazioni utilizzate da Visual Studio molto probabilmente sono una combinazione di chiavi di registro per determinare il percorso corretto per i file di documentazione.

Anche se probabilmente è possibile individuare i file di documentazione XML per i propri assiemi nella stessa cartella, si sconsiglia di farlo poiché si inquina l'installazione di Framework con file non correlati a Framework.