Vérification des commentaires de code dans les fichiers Visual Studio

Question

Je suis à la recherche d'un complément ou d'une macro Visual Studio 2008 qui examinera tous les fichiers .cs et rendra compte de la "couverture des commentaires de code". La norme de notre société est que toutes les classes, méthodes et propriétés C# sont commentées par code. J'ai une grande solution, et parcourir les fichiers à la main gaspille beaucoup de temps. Si j'avais un rapport qui me disait exactement quels fichiers contenaient des commentaires de code et lesquels ne contenaient pas de commentaires, je pourrais examiner seulement ces fichiers.

Cela ne me dérange pas d'écrire du code pour y parvenir, mais je ne veux pas réinventer la roue. Existe-t-il un complément ou une macro qui le fait? A défaut, existe-t-il un moyen d'utiliser la réflexion ou l'espace de noms System.CodeDom pour vérifier la présence de commentaires de code dans une classe? Si je pouvais juste charger mes classes dans un modèle d'objet, je pourrais probablement obtenir le reste du chemin.

Answer 1

StyleCop vérifie la documentation XML sur les classes et les membres de classe.

Answer 2

Activez simplement la sortie XML documentation dans les paramètres de construction du projet, puis activez "tous les avertissements comme erreurs". Vous allez maintenant recevoir des erreurs pour toutes les classes non documentées et les membres qui ne sont pas privés ou internes.

L'extension Ghost Doc pour Visual Studio est idéale pour réduire l'effort de frappe ici, et c'est gratuit.

Sandcastle Help File Builder est le moyen le plus simple de canaliser tout ce travail de documentation dans de jolis fichiers HTML, CHM ou HxS.

Une dernière chose sympa: il est possible que reference code regions soit inclus comme exemple dans votre documentation. Recyclez ces tests unitaires comme documentation et assurez-vous que les échantillons sont corrects: deux oiseaux avec une pierre! :-)