52 votes

Le résumé ne s'affiche pas dans l'assemblage s'il est ajouté en tant que référence

J'ai créé une 'bibliothèque de classes' en C#, qui a de nombreuses fonctions avec résumé (commentaires de documentation XML).

Par exemple

 ///<summary>
///Adds the two numbres
///</summary>
public void Add()
{
    //statements
}

si j'utilise la fonction dans le même espace de noms, elle affiche le résumé, mais si je l'ajoute comme référence dans un autre espace de travail (solution), elle n'affiche pas le résumé.

Comment le rendre visible dans d'autres solutions si on l'ajoute comme référence, et quelle peut en être la raison ?

51voto

Jon Points 194296

Vous devez générer une documentation XML pour l'assembly (un fichier nommé myassembly.xml) et la copier avec votre .dll où elle est référencée par vos autres projets. Consultez cette page dans MSDN pour obtenir des instructions.

3voto

TimothyP Points 6043

Lorsque vous compilez des classes qui ont un commentaire XML, normalement un fichier .xml est créé. (vérifiez les options dans Visual Studio)

Lorsque vous ajoutez une référence à un tel assembly, assurez-vous que le fichier XML est présent. La documentation n'est pas contenue dans l'assembly mais dans le fichier xml.

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

X