Les classes d'implémentation peuvent-elles "hériter" des commentaires XML de leurs interfaces implémentées?

Question

Question curieuse. J'utilise Microsoft Sandcastle pour générer de la documentation à partir des commentaires XML dans mon code C#. Plusieurs de mes classes implémentent des interfaces qui ont déjà des méthodes commentées. Je préfère ne pas dupliquer la documentation dans la méthode d'interface et dans la méthode implémentée par le public. Y a-t-il une sorte de balise que je peux utiliser pour "hériter" cette documentation de l'interface?

Answer 1

Cette fonctionnalité n'existe pas actuellement dans Visual Studio.

Vous pouvez obtenir des outils tiers, tels que GhostDoc, qui vous aideront à créer de la documentation XML. GhostDoc a également la possibilité de générer de la documentation qui a été "héritée" comme vous essayez de le faire.

Lien: GhostDoc

Answer 2

Vous pouvez ajouter <inheritdoc/> dans la mise en œuvre.

Vous devriez jeter un oeil sur le fil suivant: Ways to synchronize interface and implementation comments in C#

Answer 3

Dans le cas où quelqu'un d'autre est à la recherche d'une solution, je construit une bibliothèque de post-traitement des fichiers de documentation XML pour ajouter le support pour un < inheritdoc/> tag.

Plus d'informations à www.inheritdoc.io (version gratuite disponible).