Si vous avec un peu d’expérience en programmation, vous avez certainement déjà vu des balises de tâche TODO FIXME BUG etc. Ces balises de tâches, ou commentaires, sont des portions du code source ignorées par le compilateur ou l’interpréteur, car destinés en général à un lecteur humain et non censés influencer l’exécution du programme.
Commentaires TODO FIXME BUG
Les commentaires sont le plus souvent utilisés pour expliquer le code ; certains outils, appelés générateurs de documentation, permettent d’extraire l’information disponible dans les commentaires pour créer automatiquement une documentation du programme.
Les 3 principales balises de tâche sont TODO, FIXME et BUG mais selon le langage de programmation, vous pourrez retrouver HACK, UNDONE, XXX ainsi que des balises arbitraires ou définies au sein d’une organisation comme UX, REVIEW, NOTE, etc.
Selon votre éditeur de code, vous pouvez créer vos propres balises de tâche.
- TODO
- La fonctionnalité n’est pas encore mise en œuvre
- FIXME
- Le code devrait être modifié / réécrit pour atteindre un objectif (une meilleure maintenabilité, performance, etc.)
- BUG
- Le code contient un bogue connu
Prise en compte et formulation dans le code
Pour être prise en compte, la balise de tâche doit être de type commentaire et selon l’éditeur de code, généralement en majuscule.
HTML
<!-- TODO: -->
CSS
/* TODO: */
JS
// TODO:
YAML
# TODO:
PHP
<?php // TODO: ?>
En ce qui concerne les bonnes pratiques de formulation, vous pouvez :
- Simplement décrire la tâche;
- Vous identifiez
- Vous adressez à un coéquipier
<!-- TODO: Lorem ipsum dolor sit amet -->
<!-- FIXME: Hugues : Lorem ipsum dolor sit amet -->
<!-- BUG: Hugues @David Lorem ipsum dolor sit amet -->
Visualiser la liste
Les éditeurs de code ont généralement un endroit pour afficher toutes les balises sous forme de liste. L’éditeur Atom, avec l’extension « Todo-Show », peut parcourir un projet et détecter toutes les balises standards, comme TODO FIXME BUG afin de les représenter dans une liste.
Balises ou système de « Bug Tracking »?
Personnellement, pour avoir utilisez Bugzilla, Jira et autres systèmes spécialisés en « Bug Tracking », je les trouves généralement long à alimenter. Pour cette raison, je trouve plus efficace l’utilisation des commentaires type balise de tâche dans le travail courant. On peut ainsi se prendre une note à même le code source et poursuivre le travail. En fin de journée ou le lendemain, je prends le temps d’alimenter le système spécialisé grâce à la liste générée par l’éditeur de code. Si l’organisation n’utilise pas de système spécialisé, j’ai tout de même une trace dans le code source pour plus tard.
Si vous avez besoin d’aide pour mettre en place les meilleures pratiques au sein de votre équipe, n’hésitez pas à communiquer avec nous.
- Ressources externes :
-
- Auteur inconnu, « Comment (computer programming) », 7 avril 2017.
- Elliott, Micah, « PEP 350 — Codetags », 27 juin 2005.
