PHP Master | L'importance de l'examen du code

Les plats clés

• La révision du code est un examen systématique du code source de l'ordinateur, destiné à trouver et à corriger les erreurs négligées dans la phase de développement initiale, améliorant ainsi la qualité globale du logiciel et les compétences des développeurs. Cela peut être fait sous diverses formes telles que la programmation des paires, les procédures informelles et les inspections formelles.
• La révision du code diminue non seulement le nombre de défauts dans le code, mais augmente également la collaboration, aide la constitution de l'équipe, améliore la «confrérie» parmi les développeurs et propage les meilleures pratiques et l'amélioration des compétences dans une équipe ou un département.
• Les meilleures pratiques pour la revue de code comprennent la connaissance des erreurs courantes et les combattre activement, le fait d'être examiné par quelqu'un de compétences égales ou supérieures, de revoir moins de code avec des jalons clairs, de collecter des mesures et d'être conscient de l'aspect social où trouver des bugs est bon , pas mal.
• L'article souligne l'importance de ne pas considérer l'examen du code comme négatif ou une perte de temps mais comme une amélioration du flux de travail quotidien. Cela suggère que si votre équipe ne l'utilise pas aujourd'hui, suggèrez-le, car tout type d'examen de code est meilleur que rien.

Chaque développeur connaît la douleur des erreurs banales. Un mauvais attribut ici, une propriété mal orthographiée là-bas, une ligne de code accidentellement dupliquée que vous avez manquée à cause du hackathon de 16 heures à café sur lequel vous avez été. Même un $ simple avant l'étiquette PHP d'ouverture que vous y mettez accidentellement parce que vous avez commencé à taper avant que l'IDE inférieur de Java ne réchauffait et repositionne le curseur peut vous laisser vous gratter la tête pendant des heures si vous êtes fatigué et distrait . Si seulement vous aviez une nouvelle paire d'yeux pour regarder ce que vous avez fait - ces erreurs pourraient sûrement être facilement évitées? Wikipedia définit l'examen du code comme suit:

La revue de code est un examen systématique (souvent connu sous le nom de parcours par les pairs) du code source de l'ordinateur. Il est destiné à trouver et à corriger les erreurs négligées dans la phase de développement initiale, améliorant à la fois la qualité globale des logiciels et les compétences des développeurs. Les critiques sont effectuées sous diverses formes telles que la programmation des paires, les procédures informelles et les inspections formelles.

Cette définition est aussi précise que possible - en termes encore plus simples, l'examen du code est simplement l'acte de voir quelqu'un d'autre regarder votre code pour trouver les erreurs que vous avez manquées.

Les types de revue de code

Comme la définition de Wikipedia le laisse entendre, il existe de nombreuses façons de revoir le code pour les défauts. Voici une rupture rapide de quelques-unes d'entre elles:

• OTS (sur l'épaule) Revue - C'est ainsi que les petites équipes gèrent généralement les avis de code. Un développeur rédigera une quantité décente de code et appellera un autre développeur pour y jeter un œil. L'autre développeur est assis là tandis que le premier explique ce qu'il a fait, ligne par ligne. À travers ce récit, le développeur original remarque certaines de ses propres erreurs et les corrigent, et le développeur OTS en remarque d'autres, les soulignant vers le premier. Ils partagent également des opinions sur les solutions à certains problèmes que le développeur d'origine refera parfois une fois le processus d'examen terminé, appelant à nouveau un examen. Cela peut également être facilement fait avec le logiciel de partage d'écran et le chat vocal si les développeurs sont éloignés.
• Revue assistée par outils - Il existe divers outils en ligne et hors ligne pour aider à la révision du code. Bien qu'un regard détaillé sur les différents outils proposés soit en dehors de la portée de cet article, nous pouvons généraliser et dire qu'il existe des versions payantes (atlassian Crucible, CodeCollaborator), des versions gratuites (comité d'examen) ou, si vous êtes développeur en solo, le Version de la communauté (Examen de code d'échange de pile). Quel que soit l'outil utilisé, chacun sert à peu près dans le même but - il récupère les modifications les plus récentes du code source et les signale comme un examen. Un pair - cela signifie un développeur de compétences égales ou plus grandes - puis passe en revue le code, l'indique comme examiné ou marque toutes les erreurs trouvées et fait des suggestions, et termine ou réinitialise le processus en le renvoyant au développeur d'origine. Il est également important de noter que de nombreux IDE populaires ont des plugins de révision de code.
• Programmation des paires - Un type de revue de code très dynamique, la programmation des paires est un «jeu» Hotseat pour deux développeurs dans lesquels un développeur code et l'autre suit ses progrès en s'asseyant à côté de lui. Après quelques centaines de lignes de code ou après avoir atteint une étape prédéterminée, ils prennent une courte pause et des lieux de changement. Celui qui codait observe maintenant tandis que celui qui observait auparavant des codes maintenant. Ceci est extrêmement efficace pour éviter les bogues et améliorer la qualité globale du code, mais cela coûte le double de la main-d'œuvre. De nombreuses entreprises ne sont pas prêtes pour un tel risque et ne sont malheureusement pas en mesure de penser en termes autres que «deux personnes sur deux machines font plus de travail que deux personnes sur une seule machine». C'est précisément ce type de revue qui donne les meilleurs résultats: non seulement les bogues sont évités complètement, mais les deux développeurs collaborent directement et partagent des idées sur les solutions aux problèmes qu'ils rencontrent à mesure qu'ils progressent. Il ne vaut rien non plus que ce type d'examen soit incroyablement difficile à mettre en œuvre dans des équipes qui n'y sont pas habituées - cela fonctionne principalement sur des équipes plus jeunes.

Soit dit en passant, il existe également un type de revue formel, introduit et recherché pour la première fois par Michael Fagan dans les années 1970 (cette méthode est également connue sous le nom d'inspection Fagan), désormais quelque peu archaïque et en disgrâce dans l'industrie. L'inspection formelle est rarement utilisée dans les petites équipes et concerne principalement des produits de plusieurs millions de dollars car il est très intense mentalement et coûteux. Il comprend plusieurs personnes (jusqu'à six) s'asseoir avec un projecteur et examiner le code ensemble. Chaque participant se voit attribuer un rôle (comme le lecteur, le modérateur ou le réviseur) et lorsque l'équipe remarque des bogues ou des défauts de toute nature, tout est détaillé dans une large mesure - de la gravité, de la ligne de code réelle, à la cause et Effet, même le coût prévu de ce bogue atteignant les clients. Il s'agit de loin de l'examen de code le plus professionnel, mais aussi le plus décourageant pour les développeurs et en tant que tel non largement adopté. Des études ont montré que d'autres méthodes d'examen du code étaient tout aussi efficaces si elles sont utilisées, sans avoir besoin de lier autant de personnes pendant si longtemps.

Best Practices for Code Review

Une fois qu'il a été décidé d'implémenter l'examen du code, il y aura probablement des obstacles à surmonter. La direction peut ne pas voir la justification des prises sur le temps supplémentaire, ou certains programmeurs peuvent penser qu'un examen est une attaque personnelle contre le code qu'ils ont travaillé dur pour créer. Voici quelques conseils que vous ferez bien de garder à l'esprit lorsque l'examen du code est implémenté.

1. Connaissez vos erreurs communes et combattez-les activement. Lorsque vous travaillez, chaque développeur a des erreurs qu'il fait généralement, peu importe la profondeur «dans la zone» qu'il est. Chacun de nous a ce petit problème qui est tout simplement idiot et remarqué par les autres. Prenez note de ces glissades. Vous avez oublié de filtrer l'entrée… encore une fois? Vous avez oublié de commenter une méthode… encore une fois? Avec une liste comme celle-ci, un développeur peut traquer activement ces erreurs avant d'appeler un examen. Ceci est connu comme l'effet de l'ego - vous savez que votre code est sur le point d'être examiné et vous ne voulez pas entendre le critique dire "Aw mec, vous avez oublié de filtrer à nouveau la saisie!" Vous voulez être le Rockstar, le Ninja, la personne qui fait dire que les autres disent "wow, c'est en fait une excellente solution". L'effet de l'ego est ce qui vous incitera à améliorer votre code avant même que les autres aient une chance de y jeter un œil.
2. La révision du code par les pairs signifie être examinée par une personne de compétence égale ou supérieure. Comme cela devrait être le bon sens, la révision du code ne peut pas fonctionner lorsqu'un junior examine un code de senior. Le junior pourrait remarquer certaines divergences habituelles, des violations de norme, des fautes de frappe ou même des erreurs comme le filtrage des entrées, mais ne seront généralement pas en mesure d'identifier un problème plus important. Cela nécessitera souvent la définition d'une hiérarchie par compétence dans l'équipe si l'on n'est pas déjà présent.
3. Moins de code avec des jalons clairs signifie de meilleures critiques. Le code ne doit être examiné qu'après une étape personnelle atteinte, et ces étapes doivent être faibles et devraient se produire souvent. Dans la programmation orientée objet, cela est particulièrement important, mais aussi particulièrement faisable. Terminé un nouveau composant qui étend une interface qui est liée à un adaptateur qui a déjà été examiné? Enfin, résoudre un problème avec une méthode spécifique qui dérange le département depuis une semaine? Super! Composant par composant, et le garder jusqu'à un maximum de 700-800 lignes de code à la fois (commentaires inclusif) est ce qui produit le processus de révision le plus efficace. Gardez le code dont vous avez besoin examiné court, concis et indépendant et effectuez l'examen dès que possible après avoir terminé tandis que les idées sont toujours fraîches dans votre esprit. N'oubliez pas - le temps coûte cher, alors n'en prenez pas trop! Une heure devrait être plus que suffisante pour effectuer cette «revue de section».
4. Collectez des mesures. Ceci est plus facile si vous utilisez un type de revue de code plus structuré comme l'outil assisté ou formel, mais que vous pouvez également être fait en OTS. Essayez de noter le nombre et les types de bogues et de dérapages que vous trouvez via un nombre donné de lignes de code et d'unités de temps. Gagnez ces données entre les développeurs et découvrez facilement qui a besoin du plus d'aide, qui inflige le plus de normes et combien d'argent vous avez réellement économisé votre entreprise en effectuant un examen du code. Bientôt, vous pourrez réellement quantifier l'utilité de l'examen du code, et ce n'est qu'alors que tout le monde dans l'entreprise devient activement intrigué par celui-ci. Il s'agit généralement de la partie la plus difficile d'une revue à mettre en œuvre, car peu de développeurs ont la patience des statistiques manuelles, mais cela peut être bénéfique s'il est adopté.
5. Soyez attentif à l'aspect social - trouver des bugs est bon, pas mal! Il est impératif de se rappeler que trouver des bugs est bon, pas mal. Ne stigmatisez ni ne stigmatisez jamais un développeur qui a fait une erreur, le faites informel. Demandez aux gens de s'adapter à l'examen du code - aidez vos pairs à l'accepter, pas en craindre. La révision du code peut non seulement être utile - elle peut également être amusante. N'oubliez pas que plus de temps et des tâches plus difficiles égalent plus de bugs - le nombre de bugs n'indique pas les compétences d'un développeur! Si vous êtes un manager ou un chef d'équipe, assurez-vous que personne ne considère la révision du code comme négative ou une perte de temps. Assurez-vous qu'ils ne le considèrent pas comme une règle appliquée par l'entreprise, mais comme une amélioration de leur flux de travail quotidien qu'ils devraient conserver, quelle que soit l'entreprise pour laquelle ils travaillent. Dans la mesure du possible, recherchez une approche personnelle de l'examen du code. Si vous utilisez des outils, utilisez-les également dans OTS. L'approche personnelle du brainstorming mutuel et de la discussion informelle des solutions potentielles aux problèmes sont inestimables dans le processus d'acceptation de la révision du code en tant qu'ami.

en conclusion

L'examen du code peut être incroyablement difficile à mettre en œuvre, en particulier dans une équipe de anciens qui n'y sont pas habitués. Mais une fois terminé, cela ne réduira pas seulement le nombre de défauts dans votre code, il augmentera également la collaboration et aidera l'équipe à constituer, à améliorer la «fraternité» parmi les développeurs et propagera les meilleures pratiques et l'amélioration des compétences dans une équipe ou un département entier. Tout type d'examen de code est meilleur que rien, donc si votre équipe ne l'utilise pas aujourd'hui, suggérez-le. Cela ne peut que vous aider. Si vous êtes un développeur en solo, trouvez un esprit apparenté pour revoir le code - allez en ligne, socialisez, développez vos cercles de développement, faites équipe. Ne considérez pas les autres développeurs comme une concurrence et une revue de code comme votre ennemi, regardez les autres comme des frères dans les armes avec le code examen comme arme sur les lignes de front à la perfection. Image via Fotolia

Les questions fréquemment posées sur la revue de code

Quelle est l'importance de la revue de code dans le développement de logiciels?

La revue de code est un processus essentiel dans le développement de logiciels qui consiste à vérifier le code d'un autre développeur pour les erreurs, les bogues ou toute amélioration potentielle. Il aide à maintenir un niveau élevé de qualité du code, garantit que le code est lisible et compréhensible par les autres et favorise le partage des connaissances entre l'équipe. La révision du code aide également à attraper et à corriger les bogues au début du processus de développement, en réduisant le coût et l'heure des corrections de bogues dans les étapes ultérieures.

Quelles sont les meilleures pratiques pour effectuer une revue de code?

Certaines meilleures pratiques pour effectuer une revue de code comprennent la compréhension du contexte du code, en se concentrant sur la logique et la structure du code plutôt que sur le style de codage, en fournissant des commentaires constructifs et en ne dépassant pas le processus d'examen. Il est également important d'impliquer les bonnes personnes dans le processus d'examen, généralement celles qui connaissent la base de code et la fonctionnalité spécifique en cours d'examen.

Comment puis-je rendre ma revue de code plus efficace?

Pour rendre votre revue de code plus efficace, vous devez vous assurer que votre code est explicite, bien documenté et suit les normes de codage de votre équipe. Vous devez également décomposer vos modifications en petits morceaux gérables qui sont plus faciles à examiner. De plus, l'utilisation d'un outil d'examen de code peut aider à rationaliser le processus d'examen et à la rendre plus efficace.

Quelles sont les erreurs courantes à éviter dans la revue de code?

Certaines erreurs courantes à éviter dans la revue de code Inclure le fait de ne pas examiner le code en profondeur, de se concentrer trop sur le style de codage plutôt que sur la logique et la structure du code, la non-fourniture de commentaires constructifs et la précipitation du processus d'examen. C'est aussi une erreur de ne pas impliquer les bonnes personnes dans le processus d'examen.

Quels sont les bons outils de révision de code pour PHP?

Il existe plusieurs bons outils de révision de code pour PHP, y compris PHP_CODESNIFFER, PHP Mess Detector et Sonarqube. Ces outils peuvent aider à automatiser le processus d'examen du code, à capturer les erreurs de codage communes et à appliquer les normes de codage.

Comment puis-je préparer mon code pour examen?

Pour préparer votre code pour examen, vous devez Assurez-vous qu'il est propre, bien documenté et suit les normes de codage de votre équipe. Vous devez également décomposer vos modifications en petits morceaux gérables qui sont plus faciles à examiner. De plus, vous devez fournir un résumé clair et concis de vos modifications pour aider le réviseur à comprendre le contexte de votre code.

Comment puis-je fournir des commentaires constructifs dans une revue de code?

Lorsque vous fournissez des commentaires Dans une revue de code, vous devez vous concentrer sur le code, pas sur la personne. Soyez précis et clair dans vos commentaires et fournissez des suggestions d'amélioration. Il est également important d'être respectueux et professionnel dans vos commentaires.

Comment puis-je gérer les commentaires dans une revue de code?

Lorsque vous recevez des commentaires dans une revue de code, il est important de garder l'esprit ouvert et ne pas prendre les commentaires personnellement. Considérez les commentaires comme une opportunité d'apprendre et d'améliorer vos compétences de codage. Si vous n'êtes pas d'accord avec un commentaire, discutez-en avec le réviseur pour comprendre leur point de vue.

À quelle fréquence dois-je effectuer des avis de code?

La fréquence des avis de code peut varier en fonction de l'équipe et de la projet. Cependant, il est généralement recommandé de procéder régulièrement à des avis de code, comme une fois par semaine ou pour chaque fonctionnalité ou correction de bogue majeure. Les avis de code réguliers peuvent aider à attraper et à corriger les bogues au début du processus de développement.

Les avis de code peuvent-ils améliorer la collaboration d'équipe?

Oui, les avis de code peuvent améliorer considérablement la collaboration par équipe. Ils favorisent le partage des connaissances entre l'équipe, aident à maintenir un style de codage cohérent à travers la base de code et à créer une culture de propriété de code collectif. Les avis de code offrent également aux développeurs juniors l'occasion d'apprendre des membres de l'équipe plus expérimentés.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!