Gérer vos commentaires java en tâches

Par
root@khalid
Publié: 17 avril 2010Publié dans: JAVA, Trucs & Astuces

Souvent lorsqu’on travail sur un projet on est amené à commenter le code source pour une raison ou une autre, dans la plus part des cas on les oublie. Cet article montre une manière de gérer les commentaires les plus importants dans projet Java sous l’IDE eclipse en tant que tâches.

Pour mieux vous rapprocher de l’idée, supposant qu’on travail sur un projet de site web d’achat en ligne qui représente une brique parmi d’autre telle que la brique payement d’un grand projet SOA, et donc on est amené à faire des appels aux services des autres briques qui ne sont pas encore disponibles.

Pour résoudre cette problématique, on doit bouchonner les appels en écrivant des méthodes permettant de simuler les traitements des services appelés.

Par exemple, la validation de l’achat d’un panier de produits doit faire appel au payement de panier, puise que le service de payement n’est pas encore disponible on va le bouchonner par la méthode suivante (la méthode en réalité est beaucoup plus complexe que ça) :

public Boolean payerPanier(PanierDTO panier, UserDTO user) {
// A ne pas oublier d’implémenter le code d’appel au service payement
return true;
}

A force de se concentrer sur le codage du site web, on oublie qu’on a pas encore fait le vrai appel ou service payement et ce genre d’erreur on le voix qu’à l’étape de la qualification du projet.

Pour éviter ce genre d’erreur, Java propose une manière de gérer ce genre de commentaires en utilisant les tâches qui permettent d’indiquer tout ce qui reste à faire dans un projet. Une tâche représente un simple commentaire dans le code source mais en commençant par une tag déterminant son importance (basse, moyenne ou élevée).
Pour consulter la liste des tags possibles dans projet eclipse rendez vous à « Window >> Préférences >> Java >> Compiler >> task tags » Java propose trois type de préfixe qui sont :

  • TODO
  • FIXME
  • XXX

« TODO » est utilisée pour les traitements qu’on va complimenter dans l’avenir, son importance est moyenne. Dans notre exemple :

public Boolean payerPanier(PanierDTO panier, UserDTO user) {
//TODO Appeler Le service Payement
return true;
}

Le résultat dans la fenêtre des tâches est le suivant :

« FIXME » est utilisée dans le cas ou l’opération génère un bug (impossible de récupérer le résultat de l’opération), dans certains conditions, et qu’on peut pas fixer l’erreur tout de suite, son importance est élevée. Par exemple :

public Boolean payerPanier(PanierDTO panier, UserDTO user) {
//TODO Appeler Le service Payement
//FIXME Fixer moi PLZ
return true;
}

Donne le résultat suivant :

« XXX » est utilisé dans le cas ou l’opération fait son traitement même si elle génère des bugs ou des warnings, sont importance est basse (personnellement je ne l’utilise pas). Par exemple :

public Boolean payerPanier(PanierDTO panier, UserDTO user) {
//TODO Appeler Le service Payement
//FIXME Fixer moi PLZ
//XXX Quoi faire
return true;
}

Le résultat est :

Pour mieux gérer ces tâches, les développeurs préfèrent ajouter des tags personnalisées, personnellement, j’ajoute dans mes projets deux tags :

  • « ADDME » : avec une importance élevée, concerne les traitements Important que je doit implémenter, par exemple une opération permettant de générer un code à partir de quelques critères qu’on a pas encore identifiés.
  • « BOCH » : avec une importance élevée, me permet de garder l’Å“il sur les opérations que je bouchonne.

Ceux qui ont consulté cet article ont également vu ces articles :

A propos de l'auteur

Faut il vraiment porter des lunettes, pour travailler la nuit, sur un terminal vert sur noire, pour être Geek pour devenir root ?