Comment les commentaires XML du code source .NET peuvent-ils être conservés dans les métadonnées de l'assembly?

Question

Avez-vous remarqué que pour certaines méthodes dans les assemblys système, le .NET Reflector affiche également la documentation correspondante? Ce qui signifie que la documentation peut être conservée dans les métadonnées de l'assembly.

Comment puis-je le faire fonctionner pour mes propres assemblages? C'est-à-dire, je veux voir mes commentaires à ma méthode quand je le reflète dans le réflecteur de .NET.

Merci.

Answer 1

Les commentaires de document XML ne sont pas conservés dans les métadonnées de l'assembly. En fait, Visual Studio et d'autres outils, tels que Reflector, localisent les commentaires de document XML en effectuant une recherche dans un ensemble de chemins connus contenant des fichiers de commentaires doc XML. Si vous souhaitez afficher la documentation XML pour vos propres assemblys, assurez-vous que le fichier XML se trouve dans le même répertoire que l'assembly référencé et partage le même nom que votre assembly (moins l'extension). Par exemple, MyAssembly.Namespace.XML correspond à l'ensemble MyAssembly.Namespace.dll. Pour plus d'informations, voir How to see XML comments of the code from Reflector pour plus d'informations.