In che modo i commenti XML del codice sorgente .NET possono essere mantenuti nei metadati dell'assembly?

Question

Hai notato che per alcuni metodi negli assembly di sistema, .NET Reflector mostra anche la relativa documentazione? Ciò significa che la documentazione può essere mantenuta nei metadati dell'assembly.

Come posso farlo funzionare per i miei assiemi? Voglio dire, voglio vedere i miei commenti sul mio metodo quando lo rifletto in .NET Reflector.

Grazie.

Answer 1

I commenti sui documenti XML non sono persistenti nei metadati dell'assembly. In effetti, Visual Studio e altri strumenti come Reflector individuano i commenti dei documenti XML cercando attraverso una serie di percorsi noti che contengono file di commenti dei documenti XML.

Se si desidera visualizzare la documentazione XML per i propri assiemi, assicurarsi che il file XML sia nella stessa directory dell'assembly a cui si fa riferimento e che condivida lo stesso nome dell'assembly (meno l'estensione). Ad esempio, MyAssembly.Namespace.XML corrisponde all'assembly MyAssembly.Namespace.dll .

Vedi Come vedere i commenti XML del codice da Reflector per ulteriori informazioni.