Code Revision

Qu’est-ce que la révision de code ?

La révision de code consiste en “un examen systématique du code source d’un logiciel”. Présenté en tant que tel, la révision de code peut apparaître comme un processus assez naturel à réaliser. Toutefois, c’est dans sa formalisation qu’elle prend tout son sens. Le mot clé de cette définition est “systématique”. Il ne s’agit pas de réviser le code seulement à l’apparition d’un bug ou quelconque problème – ce qui paraît somme toute assez évident- mais plutôt d’effectuer cet examen de manière récurrente et automatique.

La révision de code permet ainsi notamment d’anticiper des bugs, avant même que ceux-ci ne se manifestent, mais également de corriger du code qui serait difficile à interpréter voire incompréhensible. En somme, la révision de code est un mécanisme d’anticipation, permettant d’être dans la proaction plutôt que la réaction face à d’éventuels problèmes dans le code source.

Comment réaliser une revue de code ?

Avant de se préoccuper de son execution en tant que telle il est important d’identifier les acteurs pertinents qui se chargeront de la relecture du code. L’auteur du code n’est certainement pas la personne la plus appropriée pour ce travail en ceci qu’elle ne sera pas à même d’apporter un regard nouveau et extérieur sur son travail. Cela comporterait le risque que cette personne s’enferme dans sa propre logique et se retrouve aveuglé face à certaine problématiques, nécessitant une approche différente. Ainsi, la relecture de code nécessite l’intervention d’un nouvel acteur, que l’on pourrait qualifier de “relecteur” du code (tandis que le premier en serait l’auteur).

Il n’existe pas de méthode universelle pour la relecture de code mais certaines sont néanmoins particulièrement répandues et certains principes restent inamovibles. Tout d’abord, il est généralement préférable d’attendre que le code soit intégralement rédigé avant de procéder à la relecture. En effet, toute modification postérieure par l’auteur du code imposerait une nouvelle relecture, ce qui n’est évidemment pas optimal en terme de gestion du temps et des ressources. Les méthodes les plus répandues sont les suivantes:

• Les pull ou merge requests : Un développeur envoie ses changements et une autre personne valide et intègre le moment venu.
• « Analyse par-dessus l’épaule » : L’auteur commente son code et le relecteur donne des conseils ou pose des questions en direct.
• La revue de code par mail : Il est possible de faire une simple liste de diffusion et de s’envoyer des patchs par mail. La relecture se fait alors directement par retours de mails.

Pour de plus amples informations, le site ci-dessous est particulièrement clair et détaillé:

https://zestedesavoir.com/articles/2889/la-revue-de-code-cest-important/

Bénéfices de la révision de code

Comme mentionné en introduction, la révision de code comporte des avantages multidimensionnelles.

Sur l’aspect purement technique d’abord, il permet de limiter et surtout d’anticiper d’éventuels bugs dans le code source. Le double regard permet de combiner deux approches différentes, et idéalement complémentaires, et donc de déceler plus d’inconsistances. Cela permet également d’obtenir un code plus clair, car pour permettre la communication entre les deux protagonistes il est nécessaires que le code soit lisible et intelligible par ces deux-mêmes personnes.

Sur l’aspect humain, la relecture de code permet également aux deux protagonistes de progresser considérablement en étant confronté à des méthodes et des manières de penser différentes. Les deux doivent faire un effort de compréhension de l’autre et de son travail et ainsi sortir de sa zone de confort. Comme évoqué dans le paragraphe ci-dessous, cela les force également à soigner leur communication et l’écriture du code afin de faciliter le dialogue. Et pour exprimer clairement ses idées aux autres, il est nécessaire que celles-ci soient claires pour soi-même.