Comment afficher la documentation XML pour une bibliothèque C# référencée?

Question

Supposons que vous ayez une bibliothèque C# avec plusieurs fonctions, toutes documentées avec les /// <summary> habituelles bien remplies. Le référencement du projet fera apparaître la description de la fonction et du paramètre dans l'aide contextuelle de Visual Studio. Mais est-il possible d'avoir ce spectacle si vous ne référencez pas le projet lui-même, juste un build (et potentiellement un autre fichier qui contient la documentation)?

Answer 1

Oui, il y a - la bibliothèque doit être construit avec le « fichier XML Documentation » tickbox vérifié (dans les pages de propriétés du projet)

Avec cette option cochée le processus de construction construira maintenant fichier XML supplémentaire dans le répertoire de sortie qui contient toute la documentation xml - à chaque fois que Visual Studio fait référence à un assemblage par fichier, il chargera et affichera la documentation intellisense à partir de ce fichier XML (s'il peut être trouvé).

Vous devez distribuer ce fichier aux côtés (dans le même répertoire que) votre bibliothèque compilée.