Intégration de la documentation Intellisense Xml dans Assembly?

Question

J'ai un assemblage contenant une documentation très complète basée sur XML, qui est utilisée par Sandcastle pour générer les fichiers d'aide du produit. Nous utilisons également les fichiers XML de sortie pour fournir Intellisense approprié dans Visual Studio lorsque les programmeurs utilisent évidemment l'assembly.

Pour ce faire, il semble que nous ayons à la fois fourni à l'utilisateur l'assembly ("assembly.dll") et la documentation ("assembly.xml").

Est-il possible d'intégrer la documentation dans l'assemblage, de sorte que nous n'aurions qu'à fournir le fichier d'assemblage unique et que Visual Studio serait en mesure d'extraire les informations? Peut-être intégré comme ressource ou quelque chose comme ça?

Answer 1

Malheureusement, vous devrez fournir les deux, Visual Studio ne connaissant que l'examen de documents XML pour Intellisense.

Answer 2

Si vous effectuez une recherche dans C: \ Windows \ Microsoft.NET \ Framework \ v2.0.50727, vous constaterez que tous les assemblys .net auxquels vous faites référence dans vos applications utilisent les fichiers xml. Visual studio ne fournira intellisense aux assemblys que si le fichier XML existe. Par exemple, si vous deviez fermer Visual Studio, puis supprimer le fichier System.Drawing.xml puis rouvrir VS, il ne devrait pas y avoir d'intellisense pour cet assembly. Vous devez ensuite fermer le VS, le recopier, puis rouvrir VS pour que l’intellisense fonctionne à nouveau.

Answer 3

Est-ce que je manque quelque chose? Je commente toujours comme d'habitude (en utilisant 3 barres obliques ou 3 graduations (vb)), utilise les balises XML intégrées et lorsque j'utilise l'assembly, j'obtiens l'intellisense - j'utilise rarement un fichier XML extrernal.