Quelles sont les meilleures pratiques pour travailler efficacement avec le code hérité ?

Travailler avec du code hérité peut empêcher même les meilleurs programmeurs de dormir la nuit. Il implique souvent un débogage laborieux d'individualités méthodes et la découverte de dépendances illogiques - bien que parfois seulement à première vue. Dans cet article, vous apprendrez comment le code hérité est créé et quelles techniques et outils vous devriez utiliser pour travailler efficacement avec, tout en augmentant votre productivité et en évitant un stress inutile.

Qu'est-ce que le code hérité ?

Le code hérité est un terme qui désigne le code source existant qui a été créé dans le passé et qui reste utilisé. Au début d'un projet, il était peut-être compréhensible et lisible. Au fil du temps, cependant, tous les écarts par rapport aux bonnes pratiques de programmation et aux hypothèses originales faites par le développeur ou l'équipe ont fini par devenir un gros problème. En conséquence, un tel code peut être difficile à comprendre, à maintenir et à développer en raison d'un manque de documentation ou d'une structure insuffisante.

Les développeurs ont des avis différents sur le code hérité - certains peuvent le voir comme un défi, d'autres comme un fardeau. Il est important de trouver des stratégies efficaces pour travailler avec afin de garantir que le développement d'une application ou d'un site web se poursuit. Comment pouvez-vous reconnaître le code hérité ? 

Signaux indiquant que vous traitez avec un code hérité

Il existe plusieurs indicateurs clairs qui vous permettront de juger que le code est de nature héritée. Voici quelques exemples, choisis par des développeurs expérimentés chez Droptica :

1. Code dans une langue autre que l'anglais - l'utilisation d'un langage de programmation unifié aide à améliorer la clarté du code, le rendant plus facile à comprendre et à maintenir par d'autres développeurs à l'avenir. Voir une variable isPremiumUser, tout développeur reconnaîtra l'objectif de son utilisation. En revanche, l'utilisation de la variable polonaise jestUzytkownikiemPremium peut être déroutante ou incompréhensible pour les personnes qui ne connaissent pas la langue polonaise.
    
2. Code mal formaté - la lisibilité du code a un impact clé sur l'efficacité du travail. En utilisant un formatage non standard, le programmeur rend le code lisible uniquement par lui-même (du moins jusqu'à ce qu'il oublie ce à quoi il était censé servir), et dès les premiers changements ou débogages, un tel code posera problème.
    
3. Code non orienté objet - est souvent considéré comme un code hérité car la programmation orientée objet est désormais le paradigme dominant. Le code non-objet peut se caractériser par un manque de structure orientée objet, des variables globales, une complexité procédurale et des modèles de conception obsolètes, rendant difficile sa maintenance et son développement.
    
4. Code sans testabilité - le manque de tests automatisés pour le code ne permet pas une vérification efficace de sa justesse et de ses performances. En conséquence, il est plus sujet aux erreurs, difficile à maintenir et à développer. Ne pas tester le code peut également conduire à des changements qui comportent le risque d'effets secondaires indésirables ou de régressions. Par exemple, en corrigeant un élément, un programmeur peut par inadvertance en casser plusieurs autres dans le processus et ne même pas s'en rendre compte. 
    
5. Code sans documentation - est parfois considéré comme du code hérité en raison de la difficulté qu'il crée à comprendre son fonctionnement, ses objectifs et ses dépendances. L'absence de documentation adéquate rend difficile pour les autres de faire des modifications, de maintenir et de développer le code. Cela peut également mener à la nécessité d'un travail de détective, ce qui augmente le risque d'erreurs et affecte l'efficacité des développeurs.
    
6. Logiciel non pris en charge - le support des logiciels (langage de programmation, framework, modules et bibliothèques supplémentaires) inclut les mises à jour régulières, les correctifs de sécurité et l'assistance technique des développeurs. Aucun support actif signifie que le logiciel peut être obsolète, contenir des vulnérabilités de sécurité et ne pas interagir avec de nouveaux environnements. Avec un tel logiciel, la maintenance et le développement du code deviennent plus difficiles.

Comment éliminer le code hérité d'un projet ?

Éliminer le code hérité tout en travaillant sur le projet est essentiel pour maintenir la qualité du code et faciliter le développement futur de logiciels. Plusieurs pratiques efficaces peuvent être mises en œuvre dès la phase d'écriture du code afin que le code ne soit pas perçu comme un héritage à l'avenir.

1. Écrire du code selon les normes

Créer du code selon les normes est un facteur important pour prévenir le code hérité. L'utilisation de normes de codage uniformes, telles que les noms, la structure des fichiers, le formatage et les commentaires, facilite la compréhension du code par d'autres programmeurs. Grâce à cela, le code devient plus clair, plus facile à maintenir et à modifier, minimisant le risque qu'il soit considéré comme un code hérité à l'avenir.

En outre, l'utilisation de bonnes pratiques, comme la séparation en modules, la gestion appropriée des dépendances et l'évitement de la complexité excessive, aide à créer un code plus flexible et évolutif qui est plus susceptible d'être développé sur le long terme.

2. Appliquer les principes de bonne programmation

L'important pour réduire le code hérité est la mise en œuvre de principes de bonne programmation. Cela inclut, par exemple, les approches SOLID et KISS : 

• SOLID est un ensemble de principes de conception logicielle qui promeuvent la flexibilité, l'évolutivité et la maintenabilité du code grâce à l'application de 5 règles. Vous pouvez en lire plus à ce sujet dans l'article : Les meilleures pratiques de refactorisation de code qui vous aideront dans votre travail quotidien.
   
• KISS, ou "Keep it simple, stupid," est une règle qui peut être simplement expliquée par le slogan : éviter une complication inutile des activités. Si vous pouvez rendre quelque chose plus facile, faites-le tout simplement.

L'utilisation de ces principes et d'autres modèles de conception éprouvés aide à garder le code lisible, modulaire et facilement extensible. De plus, garder le code propre en éliminant la complexité excessive, la redondance et les dépendances inutiles réduit également le risque que le code devienne un code hérité.

Des pratiques telles que les revues de code régulières, la documentation et l'utilisation de noms de variables et de fonctions descriptifs contribuent également à maintenir le code en bon état et à minimiser le risque de code hérité.

3. Travailler avec le responsable technique pour contrôler le développement de l'application

Une autre bonne pratique pour travailler avec du code hérité est d'impliquer un leader technique (tech lead) dans le processus. Ce spécialiste doit contrôler le développement de l'application et son architecture afin d'éviter la création de code hérité pour plusieurs raisons importantes.

Premièrement, le tech lead est responsable de garantir la cohérence architecturale et la conformité dans le projet. En supervisant le travail de l'équipe, le tech lead peut surveiller si de bonnes pratiques de programmation, des principes de conception et des normes de codage sont suivies, aidant à maintenir la qualité du code et à éviter la création de code hérité potentiel.

Deuxièmement, contrôler le développement de l'application permet au tech lead de suivre tout changement dans les exigences et les technologies. Au fur et à mesure que l'application change, le tech lead peut ajuster son architecture pour répondre aux nouvelles exigences et utiliser les dernières techniques et outils de développement. Cela empêche l'application de devenir obsolète et difficile à maintenir.

Enfin, le tech lead doit gérer la dette technologique. Ce spécialiste peut identifier les domaines nécessitant une refactorisation, des correctifs et des optimisations pour maintenir le code en bon état. Cela empêche la création de code hérité, conduisant à des difficultés dans la mise en œuvre des modifications.

4. Créer du code sans commentaires

Écrire du code selon le principe "un bon code n'a pas besoin de commentaires" aide à éviter la création de code hérité pour une raison simple. Quand le code est lisible en lui-même, cela signifie qu'il est bien organisé, qu'il possède des noms de variables et de fonctions appropriés, et qu'il est écrit simplement et intuitivement. Il n'a pas besoin de descriptions supplémentaires car d'autres programmeurs comprennent son intention et son fonctionnement. 

La règle de base ci-dessus permet aux développeurs de changer quelque peu leur approche. Il vaut la peine d'avoir un regard objectif sur le code en cours d'écriture et de considérer si quelqu'un d'autre peut le déchiffrer d'un seul coup d'œil sans indices supplémentaires dans les commentaires.

5. Utiliser des outils automatiques 

L'utilisation d'outils qui surveillent le respect des bons principes de programmation réduit le code hérité. Avec les outils d'analyse de code et les linter, vous obtenez des commentaires sur la conformité de la programmation, ce qui aide à éviter les erreurs et les mauvaises pratiques. 

Les outils de test automatisés détectent également les erreurs et les incohérences, ce qui minimise le risque de dégradation du code au statut de code hérité. En conséquence, leur utilisation aide à créer un code de meilleure qualité et plus durable.

Si vous prenez en charge un projet avec du code hérité. Dans ce cas, il est conseillé de prendre le temps, au début, d'analyser le code avec l'un des nombreux outils disponibles (sa sélection doit être adaptée au langage et au type de projet). Ils corrigent souvent automatiquement des erreurs de base, comme un mauvais formatage ou un choix incorrect de cas de variable.

Outils pour rendre le travail avec du code hérité plus facile

Travailler avec du code hérité peut être plus facile pour vous avec plusieurs outils qui vous aideront à le détecter, corriger automatiquement le formatage, et suggérer quelle fonction utiliser à la place de son prédécesseur obsolète (déprécié). Ceux-ci, bien sûr, devraient être adaptés au langage de programmation et à l'environnement utilisé. Ici, vous trouverez des exemples d'outils conçus pour le développement PHP et JavaScript.

Outils pour la vérification du code hérité 

En plus des signaux susmentionnés indiquant que vous travaillez avec du code hérité, vous pouvez également vous aider d'un IDE (Environnement de Développement Intégré). La plupart des programmes, dans une certaine mesure (cela peut également dépendre de leurs réglages, que vous devriez vous familiariser avec), attirent l'attention sur les fragments de code dupliqués, un formatage incorrect ou des écarts par rapport à la norme de codage choisie. Vous pouvez également souvent installer des extensions qui se concentrent sur le travail avec un framework spécifique, comme Drupal, Symfony ou Laravel.

Lorsque vous vérifiez la mise à jour du logiciel du projet, il vaut la peine de se rappeler qu'une grande quantité d'informations sur les versions logicielles utilisées est disponible dans le panneau d'administration du site. Vous pouvez généralement y trouver une liste des modules nécessitant une mise à jour. Du côté frontend, en revanche, les plugins de navigateur tels que Wappalyzer vous viendront en aide. Ils détectent quelles technologies sont utilisées sur la page web et analysent leurs performances.

Une analyse du site web Droptica.com réalisée avec le Wappalyzer (source)

Outils pour organiser le code hérité

Vous pouvez corriger de nombreuses petites erreurs associées au code hérité en utilisant des outils conçus pour des langages et des frameworks spécifiques. Après avoir analysé le code, ils présenteront une liste des erreurs détectées, vous informant généralement que vous pouvez en corriger automatiquement certaines. Voici des exemples de tels outils : 

• Code Sniffer - un outil populaire parmi les développeurs PHP et Drupal. Après avoir défini la norme de codage appropriée, il propose une analyse approfondie du code.
   
• CS Fixer - une solution fiable pour les développeurs utilisant le framework Symfony qui corrige et ajuste automatiquement le formatage du code aux normes établies, améliorant la lisibilité et la cohérence du projet.
   
• ESlint/JSlint - des outils populaires d'analyse statique de code JavaScript qui aident les développeurs à maintenir un code propre et cohérent en identifiant et en signalant les erreurs potentielles et les incohérences de codage.

Source: eslint.org

• PHPStan - un puissant outil d'analyse statique de code pour le langage PHP qui permet aux développeurs de détecter des erreurs, des incompatibilités de type et des problèmes potentiels lors de la compilation, améliorant la qualité et la fiabilité du code.
   
• Larastan - une extension pour PHPStan qui fournit une analyse statique de code pour les applications basées sur le framework Laravel, permettant aux développeurs de détecter des erreurs et d'améliorer la qualité du code lors de la compilation.
   
• Rector - un outil pour le langage PHP qui permet la transformation automatique du code source pour se conformer aux nouvelles normes, aux meilleures pratiques et aux conventions. Cela facilite la mise à jour d'un projet vers les dernières versions PHP et améliore la lisibilité et la qualité du code.

Pratiques pour prévenir le code hérité - résumé

Le code hérité est un terme désignant le code existant qui reste utilisé. De nombreux développeurs trouvent qu'il est difficile de travailler avec et difficile à comprendre, par exemple, en ne respectant pas les normes de codage d'un langage ou d'un framework, ou en utilisant des technologies obsolètes. 

Travailler avec du code hérité peut être facilité en mettant en œuvre les stratégies mentionnées ci-dessus et en utilisant des outils conçus pour maintenir un code propre. Ils aident à l'analyse et corrigeront automatiquement les erreurs mineures. Il est également conseillé de se rappeler et d'essayer de mettre en œuvre des tests unitaires pour s'assurer que les modifications apportées ont l'effet escompté. Si vous avez besoin d'un soutien supplémentaire avec le code hérité, notre équipe expérimentée de développement PHP, Symfony ou Drupal vous aidera à trouver la meilleure stratégie.