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

Question

Avez-vous remarqué que, pour certaines méthodes des assemblys système, le réflecteur .NET affiche également la documentation correspondante? Cela 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 assemblées? Cela veut dire que je veux voir mes commentaires sur ma méthode quand je les réfléchis dans le réflecteur .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 recherchant parmi un ensemble de chemins bien connus contenant des fichiers de commentaire de document XML.

Si vous souhaitez afficher la documentation XML de vos propres assemblys, assurez-vous que le fichier XML se trouve dans le même répertoire que l'assembly référencé et qu'il partage le même nom que votre assemblage (moins l'extension). Par exemple, MyAssembly.Namespace.XML correspond à l’ensemble MyAssembly.Namespace.dll .

Voir Comment voir les commentaires XML du code de Reflector pour plus d'informations.