Augmentez la qualité de votre code source Java en confrontant votre code à des standards de programmation. Identifiez au jour le jour et corrigez les violations aux bonnes pratique de codage. Partagez les mêm règles dans une équipe de développement.
Liens utiles
Configuration proxy sous Eclipse
Exemple rapport Checkstyle avec Maven
Programme
Partie 1 : installation
Partie 2 : configuration
Partie 3 : règles CheckStyle pour une équipe
Partie 4 : utiliser CheckStyle dans Eclipse : vue ‘violations’
Contexte
2 étapes clés dans la mise en oeuvre qualité du code :
Etape 1 : au niveau du développeur
Etape 2 : au niveau du serveur d’intégration continue
Dans ce tutoriel nous contribuons à l’étape 1.
Partie 1 : Installation
Dans Eclipse, faire Help->Install New Software
Ajoutez l’URL suivante : http://eclipse-cs.sf.net/update/
Après redémarrage d’Eclipse, le plugin apparaît dans la liste des préférences.
Expliquez la configuration par défaut de CheckStyles.
QUESTION : qu’est ce que le fichier Sun_checks.xml ?
Partie 2 : configuration
Bonne pratique : créez un fichier de configuration spécifique à votre projet.
Cliquez sur le bouton ‘configure’
Notez sur la colonne de gauche la liste des principaux thèmes de vérifications. Les règles CheckStyle sont en effet rangés par catégories :
QUESTION : combien de catégories sont présentes ?
Sélectionnez la catégorie associés aux règles d’Import :
Identifiez l’ensemble des règles disponibles (activées ou non) :
Expliquez comment activer des règles désactivées par défaut.
Partie 3 : règles CheckStyle pour une équipe
BONNE PRATIQUE : pour les membres d’une équipe , suivre les même règles.
Le plugin Eclipse Checkstyle le permet en fournissant l’opportunité de faire référence à un fichier de configuration distant pour le paramétrage de checkstyle.
Cliquez sur configuration, sélectionnez « Remote Configuration file ». Fournissez l’URL du fichier de paramétrage de l’équipe. Exemple http://www.objis.com/template_checkstyle_objis.xml
Imposer alors comme fichier de configuration CheckStyle par défaut
Partie 4 : utiliser CheckStyle dans Eclipse : vue ‘violations’
Sélectionnez un projet dans Eclipse, puis click-droit –>Activer CheckStyle
Affichez la vue CheckStyles ‘violations’
Afficher un graphe des violations des règles
Conclusion
Vous avez mis en oeuvre CheckStyle dans Eclipse.