Journaliser ses TODO dans son code 😎

Si comme moi, il vous arrive très régulièrement d'ajouter directement dans votre code en commentaire ce qu'il vous reste à faire (TODO).

Eh bien voici une petite astuce très pratique pour les lister. 🤓

Partons d'un exemple avec un bout de code Python tout bête... 👍

#!/usr/bin/env python3
# file: test.py

## TODO modifier cette class
class PythonCommand(command):

...
## TODO mais aussi cette class
class PythonMethod(method):

Dans ce cas précis, awk est mon meilleur ami. Voici le pourquoi du comment :

awk '/TODO/ {print NR "\t" ($1=$2="") $0}' test.py
10 modifier cette class
28 mais aussi cette class

Pour résumer, pour que cette méthode fonctionne à merveille, utilisez un commentaire précédé de TODO (tout en majuscule dans votre code source, comme fait dans l'exemple) ou modifiez la REGEXP /TODO/ dans le script awk au format que vous souhaitez.

Pour terminer, limitez le commentaire à une seule ligne ou ajoutez TODO au début des lignes supplémentaires dans votre bloc de commenaitres (mais c'est pas ce qu'il y a de plus opti...). 😜