5 trucs pour mieux réviser votre codage

La révision et le débuggage d’un programme est l’une des tâches les plus ardues auxquelles faire face...

Il est possible que vous ayez lu une multitude de commentaires de révision de code en espérant devenir un meilleur programmeur, sans que cela ait amélioré vos capacités de débuggage.

En effet, ce n'est pas parce qu'on est un bon lecteur qu'on est un bon écrivain, et ce n'est pas parce qu'on sait comment réviser un code qu'on est forcément capable de le faire.

Heureusement, dans un article publié sur The Muse donne cinq astuces pour mieux réviser son code.

1. Pensez à l'impact global

Parfois, vous réussirez à régler un problème isolé dans votre code sans pour autant faire fonctionner votre programme. Pire encore, il arrive parfois que la solution que vous apporterez à ce petit problème ait un impact sur le reste de votre code, ce qui ne fait que vous rajouter des bâtons dans les roues. Tâchez donc de toujours garder en tête que les solutions que vous apporterez à diverses sections de votre programme conservent le reste intact.

2. Soyez prudent

N'oubliez pas que certains changements pourraient impacter plus que la base du code. Il est recommandé d'évaluer si un utilisateur pourrait utiliser une fonctionnalité dans le cadre d'un harcèlement ou d'un abus du système. Par exemple, si une nouvelle fonctionnalité inclut une entrée utilisateur, cherchez des injections SQL, des accès aux données, du cross-site scripting, et d'autres points vulnérables dans la sécurité.

3. Concentrez-vous sur les bugs

Vos collègues codeurs, peu importe à quel point ils peuvent sembler robotiques, sont aussi humains que vous, et ne sont donc pas infaillibles. Vous devez donc revoir les tests avec autant d'attention que lorsque vous revoyez le code pour éviter de nouveaux bugs et pour pouvoir fournir une forme de documentation pour les personnes qui travailleront sur votre code dans le futur.

Analyser les tests vous permettra d'améliorer certaines fonctionnalités et d'ajouter des cas de figure auxquels vous n'aviez pas pensé auparavant. Vous devriez également faire fonctionner votre application au niveau local pour vérifier qu'elle fonctionne correctement, et ainsi déterminer si une révision supplémentaire est nécessaire ou non.

4. Privilégiez le travail d'équipe

On dit souvent qu'il faut bien faire attention au code car c'est le code de tout le monde. En tant que réviseur, vous devriez prêter attention aux bugs qui existent déjà pour éviter qu'ils ne prennent de l'ampleur, et ainsi éviter du travail supplémentaire aux collègues qui vous succèderont. N'oubliez pas pour autant les priorités de l'équipe.

Parfois, créer une liste de choses à faire et commenter le code au fur et à mesure peut faciliter le boulot de tout le monde et assurer la qualité du code.

5. Utilisez le processus pour apprendre et partager votre savoir

Le processus de révision donne à toutes les personnes impliquées l'occasion de jeter un œil à la base du code, à son langage, à sa structure, et aux meilleures pratiques. Il est bon d'observer le nom des fichiers pour obtenir du contexte.

Lorsque vous apprenez des changements de code, vous avez également une opportunité de partager vos connaissances. En effet, vous devez expliquer votre opinion et la prouver avec de la documentation. Cela aidera non seulement les réviseurs et les codeurs à explorer des approches différentes. Au minimum, commentez les lignes de code que vous avez modifiées pour que la prochaine personne puisse savoir ce que vous avez fait.