Le cadre goto définition montre les commentaires, sont-ils générés à partir de commentaires XML?

Question

J'ai récemment été légèrement surpris de découvrir que mes commentaires XML soigneusement conçus n'apparaissaient pas intelligemment pour mes collègues. Ayant toujours utilisé les assemblages associés avec des références de projet, je n’avais pas réalisé que vous deviez également exporter le document .xml pour accéder à ces informations.

Cela m’a amené à me demander comment le framework .Net intellisense fonctionne. Si je comprends bien, les fichiers .xml doivent être cachés quelque part dans un dossier spécial?

Mais ma question principale concerne la "définition de Goto" - si vous avez la définition d'un assemblage de framework .Net, vous obtenez les informations générées à partir de métadonnées - mais également avec de nombreux commentaires utiles - ces données sont-elles générées de manière magique à partir de commentaires XML, ou Est-ce que quelqu'un a dû écrire une macro pour les convertir juste pour la construction? En d'autres termes: comment puis-je obtenir cet effet pour mes assemblées?

Answer 1

Vos projets sont-ils configurés pour générer la documentation XML? Simplement parce que vous ajoutez les commentaires au code source, le compilateur ne générera pas le fichier .xml sauf indication contraire.

Dans la page des propriétés du projet, accédez à la section "Générer". Cliquez sur l'onglet et consultez le menu "Sortie". section. Vous devriez voir une entrée de case à cocher intitulée "Fichier de documentation XML". Si la zone de texte qui suit cette case est vide, vous ne générez pas le fichier de documentation XML.

Une fois le fichier de documentation XML généré, vous devriez voir vos commentaires dans les info-bulles IntelliSense. Si vous incluez des références à d'autres projets en tant que référence de projet, cela devrait se faire automatiquement. Si vous incluez des références aux assemblys, vous devez vous assurer que le fichier xml se trouve au même emplacement que l'assembly référencé. (Lorsque vous générez, vous devez obtenir des fichiers XML pour tous les assemblys qui les ont respectivement dans le dossier bin / debug ou bin / release.)

Pour les assemblys .NET Framework eux-mêmes, les fichiers de documentation xml correspondants sont installés dans le cadre de Framework. Pour .NET 2.0, 3.0 ou 3.5, les fichiers de documentation se trouvent dans C: \ Windows \ Microsoft.NET \ Framework \ v2.0.50727 \ fr (en supposant une installation par défaut de Framework). Ces fichiers sont utilisés à la fois par les info-bulles IntelliSense et par l’option "Aller à la définition". fonctionnalité dans Visual Studio afin d’afficher ces informations. Il n'y a pas de traitement spécial qui ait lieu ou de macros exécutées pour que cela se produise. La seule information la plus susceptible d’être utilisée par Visual Studio est une combinaison de clés de registre permettant de déterminer le chemin correct vers les fichiers de documentation.

Bien que vous puissiez probablement localiser les fichiers de documentation xml de vos propres assemblys dans le même dossier, je vous déconseille de le faire, car vous pollueriez ensuite l'installation de Framework avec des fichiers non liés à Framework.