3 votes

Existe-t-il un moyen d'obtenir des avertissements du compilateur en cas d'absence de commentaires XML dans les classes non publiques ?

Dans mon projet, presque toutes les classes sont internes (au lieu d'être publiques).

J'aimerais maintenant tout documenter (les classes et leurs membres publics). Malheureusement, l'avertissement du compilateur concernant l'absence de commentaires XML ne semble concerner que les classes publiques et leurs membres.

Existe-t-il un moyen d'obtenir un tel avertissement du compilateur pour les classes internes ?

(Utilisation de Visual Studio 2010 Ultimate, C# 4.0)

1voto

lysergic-acid Points 5389

Vous pouvez consulter StyleCop par Microsoft (hébergé sur CodePlex).

Il s'agit d'un outil très agréable, basé sur des règles, qui s'intègre dans Visual Studio et analyse votre solution à la recherche de problèmes de style.

Une section de ses règles s'intitule "Documentation" et fait référence à toutes sortes de styles de code liés à la documentation du code.

Voir les règles commençant par SA1600

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