@todo dans NetBeans

Dans les derniers mois, j'ai travaillé principalement sur un projet web ambitieux, avec beaucoup de fichiers, de classes, etc. Sans méthodologie de travail et cahier de production, ça pouvait devenir difficile de se rappeler toutes les nouvelles demandes, améliorations souhaitées, corrections et autres.

Comme certains autres éditeur, NetBeans IDE scrute le code du projet pour permettre la fonctionnalité d'auto-complétion sur les noms de variables, fonctions et classes. Du même coup, il recherche dans les commentaires les occurences par défaut de @todo, TODO, FIXME, XXX, PENDING et <<<<<<<, ce dernier étant relié au marqueur de conflit de SVN. Ce qui permet d'identifier les zones où du travail reste à faire, le code à paufiner ou à fixer ainsi que les omissions potentielles qu'on aurait pu oublier dans l'ensemble du projet. Avant de découvrir que NetBeans possédait une telle capacité, j'avais l'habitude de mettre un tag personnel (mon nom par exemple) que je pouvais retrouver avec effectuant une recherche dans les fichiers sources du projet. Du coup, l'éditeur offre une méthode beaucoup plus efficace qui s'avère profitable au niveau de la clareté et de la productivité. Il suffit de parsemer son code source de commentaires comme ceux ci-dessous : // @todo : simplifier cette fonction // TODO : remplacer par un composant ZF /* FIXME : bug division par zéro */ // PENDING : en attente du code du stagiaire // XXX : hum ?

Ensuite, pour faire apparaître le panneau qui liste les tâches à faire, on y accédera par le menu Window / Tasks ou encore par le raccourci CTRL+6.



Si vous travaillez avec une équipe de développeurs, vous voudrez peut-être créer vos propres identificateurs pour reconnaître à qui s'adresse la correction demandée. Une fois dans SVN, si tout le monde prend l'habitude de consulter la liste des tâches, ils verront le travail qui leur est assigné. En un simple click sur la tâche, le programmeur sera amené à l'ancre où l'identificateur a été détecté.

Pour en ajouter, rendez-vous au menu Tools / Options / Miscellaneous / Tasks. Ajoutez un nouvel élément, par exemple : @code18. Sinon, vous pouvez tout simplement indiquer de façon plus générique @todo code18.

À l'aide des icônes se trouvant à gauche de la liste, vous pourrez filtrer les tâches selon le fichier courant, le projet actuel et ses dépendances ou tous les projets ouverts.

Un dernier conseil : utilisez ces tags avec modération. C'est toujours mieux de prendre l'habitude de corriger les bugs à mesure qu'ils sont découverts plutôt que d'attendre à la fin du projet.

Tags: Programmation