Author: 
Eric Selvais

La paresse du commentaire ou l’art de rendre GIT inutile. Petite introduction a GIT : dans le monde informatique, il existe de nombreux outils de suivi de version. Le plus connu d’entre eux est sans doute GIT. Il permet de suivre précisément l’évolution d’un projet et d’en connaitre le statut. Voici un exemple de suivi de version d’un logiciel :

Les points bleus claires sont l’évolution générale du logiciel (ce que l’on appelle « master »), les points mauves représentent une nouvelle caractéristique implémentée par un programmeur (ce que l’on appelle « branch ») et les points verts représente une autre caractéristique (n’ayant aucun lien avec la première), implémentée par un autre programmeur. Chaque point correspond donc à une évolution du logiciel. Lorsqu’un point est créé, le créateur à la possibilité d’y ajouter un commentaire.

L’importance d’un commentaire explicite

Dans le développement logiciel certains schémas de GIT peuvent vite devenir très complexes.

La documentation dans ce genre de cas est primordiale. En effet, s’il n’y a pas de documentation, comment savoir à quelles fonctionnalités correspondent ces points ? Et malheureusement, la paresse ou l’excuse habituelle : « je n’ai pas le temps », reprends parfois le dessus. On se retrouve alors avec des commentaires complètement inutiles qui réduisent à néant la puissance de GIT.

Voici un exemple de suivi de version complètement inutile :

Comment savoir ce qu’il y a été fait et ce qu’il reste à faire ?? GIT ne sert donc strictement à rien.

Et voici le même schéma mais géré de manière plus efficace :

La richesse des commentaires offrent déjà un rapide aperçu de l’état de l’application sans devoir entrer dans le code.

Conclusion :

Faire un commentaire inefficace pour gagner du temps, c’est être certain d’en perdre plus tard.

Newsletter