Industrialisation des commentaires avec JAutodoc
Par philippe voncken, jeudi 25 juin 2009 à 21:23 :: Java :: #116 :: rss
De nos jours, on industrialise beaucoup de processus dans le domaine informatique en général. Industrialisation des tests. Industrialisation de la génération des livrables logiciels. Allons toujours plus loin et industrialisons la génération des commentaires dans les fichiers sources Java.
C'est possible avec JAutodoc qui est un plugin Eclipse.
Ce plugin est très utile pour tous les beans qui possèdent de nombreux getter et setter qui portent déjà un nom suffisamment clair pour ne pas avoir besoin de 10 pages de commentaires. Une combinaison de touche (Ctrl + Alt + j) permet de générer automatiquement un commentaire sur la méthode où se trouve le curseur.
Bien pratique pour les objets métiers, il ne faut pas en abuser. Dans la couche de service par exemple, il est conseillé de bien commenter ce que font les services car leur complexité peut devenir un casse tête lors de la phase de maintenance. En général, à chaque fois qu'une méthode renferme un mécanisme complexe, un beau commentaire artisanal est apprécié.
Commentaires
Aucun commentaire pour le moment.
Ajouter un commentaire
Les commentaires pour ce billet sont fermés.