Discussion :

[sierramike]

Bonjour,

Je suis à la recherche d'une méthode/script/outil permettant de faire un rapide contrôle de cohérence simple des blocs <summary>.

En effet, à la compilation, on a bien un warning si le bloc <summary> est absent. Mais aucun warning s'il manque le <return> ou si la liste des <param> n'est pas cohérente avec la signature de la méthode (paramètres oubliés ou en trop).

Quelqu'un connait-il une manière de faire un check rapide et simple de ces éléments sur l'ensemble d'un projet/solution, afin de s'assurer rapidement que le code source est commenté de façon fiable ?

Ca me semble tellement évident à faire, mais pas moyen de trouver le moindre outil sur la toile, ou alors je cherche mal ...

Merci par avance !

[tomlev]

Le compilateur ne vérifie pas tout ça, il faut passer par d'autres outils...

Des outils comme Resharper peuvent détecter certaines erreurs dans la doc (éléments manquants par exemple). Après, pour une analyse plus poussée, il faut utiliser par exemple Sandcastle (outil de génération des pages web de la doc), mais c'est une usine à gaz...

Sinon, tu peux essayer d'analyser le fichier XML généré à partir des commentaires...

[sisqo60]

Bonjour,

Tu as des outils plus généralistes qui incluent ce que tu souhaites faire. Regarde du coté de Stylecop ou FxCop.

Pour ma part, j'ai utilisé StyleCop, il contient beaucoup de règles, mais tu peux créer tes règles personnalisées (FxCop le permet peut-être aussi, mais je n'ai pas trvaillé dessus donc à voir).

EDIT : Tu as aussi un outil pour avoir une base de commentaire plus poussé que les commentaires automatiques de VS, c'est GhostDoc, lui aussi entièrement paramétrable et il te génère "automatiquement" les commentaires (mais attention il faut toujours les relire, même s'il est très bien, il se base sur le type de méthodes, leur nommage etc... Donc à ne pas mettre entre les mains de fainéants des commentaires )

J'espère que ça répond à ta problématique...