En tant que développeur iOS, j'ai passé en revue des milliers de lignes de code de mes pairs. Comme la programmation, la révision du code vous fait vous sentir intelligent ou complètement stupide.

Ceci est dû aux principaux problèmes des révisions de code :
1. Les gens ne savent pas vraiment pourquoi ils révisent le code.
2. Les gens ne passent pas en revue les bonnes choses.
3. Les demandes d'extraction ne sont pas révisables.

Dans cet article, nous nous concentrons sur les raisons pour lesquelles nous révisons le code.

Certaines des raisons

J'ai posé cette question à de nombreux candidats lors d'entretiens, obtenant une gamme très variée de réponses. Les gens examinent souvent le code parce qu'il s'agit d'une bonne pratique bien connue sans approfondir pourquoi il s'agit en fait d'une bonne pratique.

Pour comprendre pourquoi nous révisons le code, la meilleure question que nous pouvons nous poser est : pourquoi voudrions-nous que quelqu'un d'autre révise notre code ?

Voici quelques-unes des raisons :

• Nous voulons savoir si le code peut être compris par quelqu'un d'autre que nous.
• Nous voulons identifier d'autres domaines déroutants, tels que les noms de variables, les classes, les méthodes, etc.
• Nous voulons une autre paire d'yeux qui puisse nous rappeler si nous avons oublié quelque chose (c'est-à-dire que nous avons changé le nom d'une variable à la dernière minute et qu'un défaut de conception est apparu).
• Nous voulons apprendre de nos pairs si une meilleure approche pourrait être adoptée pour résoudre le même problème.
• Nous avons fait une faute de frappe et appelé une variable `tmoato` au lieu de `tomato`, donc maintenant une classe qui comptait les légumes semble invoquer les dieux mayas à la place.

Si vous regardez attentivement la liste, vous remarquerez peut-être qu'il n'y a que deux éléments sur la liste qui nécessitent en fait plus de personnes.

C'est une particularité des revues de code. Dans la plupart des cas, lorsque vous créez une demande d'extraction, vous êtes la meilleure personne pour l'examiner. Vous remarquerez des fautes de frappe et à peu près tout ce que vous avez oublié.

Les développeurs ne sont pas seuls dans ce cas. Les écrivains font de même.

Stephen King est connu pour passer par trois brouillons avant d'envoyer un roman à l'éditeur. Du premier au deuxième brouillon, il ne demande même pas de commentaires mais le révise lui-même.

Cela vous semble-t-il familier ?

Essaie.

La prochaine fois que vous créerez une demande d'extraction, examinez-la d'abord par vous-même. Demandez ensuite à quelqu'un de l'examiner. Ils mettront probablement en évidence des commentaires précieux pour vous, tels que des domaines difficiles à comprendre ou de mauvaises décisions lors de la conception d'API.

Comprendre pourquoi

Lorsque vous passez en revue votre propre code, vous pouvez facilement identifier la plupart des fautes de frappe, des tests manquants ou des erreurs de base. Cependant, si vous croyez que le mot "chef" s'écrit "chef", vous parlerez toujours de cuisiniers quand vous voudrez parler de dirigeants. Une autre paire d'yeux peut vous aider à trouver les derniers détails qui peaufinent votre code.

Cela dit, si lorsque vous révisez le code, vous ne commentez que les domaines que quelqu'un pourrait réviser par lui-même, vous passez probablement à côté de l'essentiel.

Les révisions de code consistent à obtenir des commentaires, à clarifier et à s'assurer que ce que vous comprenez peut être compris par les autres.

Et après?

Maintenant que vous savez pourquoi nous révisons le code, nous devons mieux comprendre ce qui doit être révisé et comment cela doit être fait. J'ai donné certaines des réponses dans cet article, mais je vais creuser plus profondément tout en fournissant des exemples spécifiques.

Vous pouvez suivre Volvo Cars Engineering si vous souhaitez recevoir des mises à jour lorsque le prochain article sera disponible. Ce faisant, vous aidez également de nombreux ingénieurs à partager leurs idées et leurs apprentissages.