Héritage de commentaires XML à partir d'interfaces en C #

Question

Je me demandais si quelqu'un sait comment lier une interface xml commentaire pour une mise en œuvre. Le problème est que je veux la base des commentaires à venir à partir de mon interface. Exemple:

interface myinterface {

       /// <summary>
       /// Does something.
       /// </summary>
       void method1(string foo);

}

et puis la mise en œuvre est:

public class myclass : myinterface {


       public void method1(string foo) {
             //do something...
       }
}

Alors maintenant, si je survolez la méthode avec ma souris après l'instanciation de l'objet:

myclass foo = new myclass();
foo.method1("do something");

comment puis-je faire les commentaires s'affichent dans le hover popup? Est-il un moyen je peux relier l'interface des commentaires à la mise en œuvre? Je sais qu'il y a un moyen en Java, mais ne peut pas trouver la solution pour C#.

Merci

Answer 1

Lier des commentaires XML n'est pas possible à mon humble avis , mais vous pouvez utiliser un outil tel que GhostDoc pour copier le commentaire XML à partir de votre classe / classe d'Interface vers la classe d'implémentation / dérivée.

Answer 2

XMLDoc définit une balise <include /> pour l'inclusion de commentaires provenant d'un autre fichier existant depuis Visual Studio 2003. La plus grande réserve est que le fichier référencé doit être un fichier contenant uniquement la documentation XMLDoc, et non un autre fichier source.

Voir la page MSDN pour plus de détails.

Answer 3

Si vous utilisez GhostDoc, cela "aide beaucoup à" transporter "la documentation des interfaces vers le code d'implémentation.

Answer 4

http://blog.x-tensive.com/2008/02/fixml.html

C'est un post-processeur qui dispose de certaines options supplémentaires où la documentation d'origine du système fait défaut.

Sur le site:

Bref résumé:

FiXml est post-processeur de documentation XML produit par C# \ Visual Basic.Net. Il traite de certains des plus ennuyeux cas lié à l'écriture de la documentation XML dans ces langues: - Pas de support pour l'héritage de la documentation de base de la classe ou de l'interface. I. e. une documentation pour toute substituée membre doit être écrit à partir de zéro, bien que normalement, c'est tout à fait souhaitable d'hériter au moins la partie. - Pas de support pour l'insertion d'couramment utilisé des modèles de documentation, telles que "Ce type est un singleton - utilisation de sa propriété pour obtenir la seule instance.", ou même "Initialise une nouvelle instance de la classe."