Écrire un code recyclable

La grande majorité du code que nous écrivons est destiné à servir un objectif unique et une fois utilisé à cet effet, il ne voit plus jamais la lumière du jour. C’est toutefois un peu une perte de votre temps précieux, alors qu’il est parfaitement possible d’écrire votre code de telle sorte qu’il puisse être recyclé et utilisé à de nombreuses fins différentes.

Le défi est que l'écriture de code recyclable est assez différente de l'écriture de ce que l'on pourrait appeler du code «jetable». Avec ce dernier type de code, vous devez vraiment vous préoccuper de la façon dont les autres personnes interprètent vos instructions de code si vous ne les avez pas écrites à la perfection. Toutefois, lorsque vous écrivez du code recyclable, vous devez le faire de manière très spécifique et vous devez vraiment réfléchir à la façon dont tout le monde, y compris vous-même, comprendra le code que vous avez écrit à un moment donné.

Faire les choses de cette manière prend beaucoup plus de temps et d'efforts que le codage ordinaire, mais cela a l'avantage de ne jamais avoir à écrire la même fonction exactement deux fois. Comme indiqué, vous devrez tout faire d'une certaine manière afin de vous assurer que votre code peut réellement être utilisé à d'autres fins.

Il est à noter que le code recyclable n'est pas nécessairement la même chose qu'un plug-in. Lorsque vous créez un plug-in, vous développez du code que tout le monde peut prendre et incorporer dans son site Web et en générer facilement un effet en modifiant simplement quelques paramètres.

Le code recyclable est différent en ce sens qu'il n'est pas nécessairement statique ni destiné à une distribution en dehors de votre propre organisation. Quoi qu'il en soit, il est essentiel de s'assurer que vous utilisez le processus correct, décrit ci-dessous.

1. Devenir un maître d'organisation

Lorsque vous créez du code avec l'intention de le réutiliser ultérieurement, cela ne vous aidera pas beaucoup si vous ne le trouvez pas. Vous devez faire un très bon travail de nommage, de stockage et de classification de vos fichiers de code.

2. Soyez conscient de ce qui est "spécifique à l'application" et de ce qui est "générique"

Presque toujours, il y aura du code qui est vraiment spécifique à votre application et il ne pourrait pas être utilisé autrement. Au fur et à mesure que vous créez chaque bloc de code, vous devez déterminer s'il s'agit d'un code spécifique à l'application ou générique. En fin de compte, vous voulez créer beaucoup plus de ces derniers que les premiers, et il existe un bon moyen de le faire que je vais décrire à l'étape 3.

3. Séparez le code des valeurs

Les valeurs de variable codées en dur peuvent poser un problème lorsque vous souhaitez utiliser le code de manière nouvelle. Une meilleure façon de le faire est de stocker vos valeurs de variable initiales dans un fichier CSV, puis de charger ces valeurs au démarrage de l'application. Cette méthode vous permet également de modifier facilement les valeurs des variables initiales sans altérer votre fichier de code d'origine.

4. Essayez de ne pas coder en dur les valeurs qui ne doivent absolument pas être

Cela signifie fondamentalement que vous ne devez coder aucune valeur du tout, à l'exception du nom du fichier qui sera chargé, contenant toutes les valeurs codées de manière souple. Ce fichier doit toujours être accessible par rapport au chemin racine de l'application. Sinon, vous pourriez avoir des problèmes si vous déplacez les fichiers vers un autre système d'exploitation.

5. Évitez de mettre des espaces dans les noms de fichiers

Ce n'est pas parce que vous pouvez mettre des espaces dans les noms de fichiers que vous devriez le faire. Cela peut éventuellement créer des problèmes si vous déplacez vos fichiers vers un autre système d'exploitation ou un autre système de fichiers. Par exemple, si vous déplacez vos fichiers d'ext4 vers FAT, vous risquez de rencontrer des problèmes. Fait intéressant, le système d'exploitation Windows affichera les noms des fichiers contenant des caractères non autorisés, mais ne vous autorisera aucun accès à ces fichiers, même si vous souhaitez simplement les renommer.

5. Tout commenter verbalement

Au moment où vous écrivez votre code, vous savez exactement ce qu'il va faire. Mais attendez quelques années et il est fort possible que vous ayez oublié vos intentions. C'est la même histoire quand vous utilisez le code de quelqu'un d'autre, car à moins que ceux-ci ne fournissent des commentaires verbeux, vous devrez passer de précieux moments à analyser et à interpréter ce qu'ils ont écrit.

6. Éviter de créer des dépendances

L'un des plus gros défauts de la plupart des scénarios de code réutilisable est que vous pouvez vous retrouver avec d'énormes chaînes de dépendances de fichiers. Cela se produit parce que les utilisateurs écrivent leurs fragments de code de manière spécifique et les incluent dans un ordre spécifique sans indiquer pourquoi. Puis, avant de vous en rendre compte, vous vous retrouvez face à un scénario de type Gauche-Pad et tout le monde panique lorsqu'un morceau de code dont dépend votre application va devenir AWOL pour une raison quelconque.

Vous pouvez éviter ce type de fusion en veillant à ce que chaque bloc de code puisse facilement être remplacé par un autre, à documenter comme un fou, et bien sûr à faire des copies de sauvegarde de chaque bloc.

La documentation doit indiquer ce qu'est un fichier, ce qu'il fait et pourquoi il est chargé à l'endroit même où il est chargé. Cela élimine les problèmes de dépendance potentiels, car toute partie du code peut être recréée car son objectif est connu.

7. Formatez tout votre code vraiment proprement

De toute évidence, c’est une bonne idée de toujours le faire de toute façon, mais il est particulièrement important de le faire lorsque vous écrivez du code réutilisable. Vous devez également conserver un style de codage très cohérent et ne pas le modifier. Par exemple, si vous avez tendance à écrire vos noms de constante en majuscules et les noms de variables dans camelCase, vous devez le faire avec une cohérence absolue.

8. Chaque morceau de code a un but spécifique

Votre mission est de comprendre quel est cet objectif. Vous devez éviter de permettre plusieurs objectifs par morceau. Ainsi, par exemple, si vous avez un bloc de code qui se charge dans les valeurs de variable initiales, il ne devrait rien faire d’autre que cela. Votre prochain bloc de code devrait gérer la prochaine opération requise. Quelle est la rigueur de cette règle? Eh bien, votre fonction principale ne devrait rien faire d’autre que d’appeler toutes les autres fonctions.

Il est beaucoup plus difficile d'écrire un bon article recyclable qu'on ne le pense avant de l'essayer. Quelles que soient vos intentions initiales, vous constaterez probablement qu'environ 80% du code que vous écrivez finira par être spécifique à l'application plutôt que générique. La plupart des gens raffolent du code recyclable sans avoir la moindre idée de la façon dont ils l'utiliseront à l'avenir, avec pour résultat final de créer plus de travail pour eux-mêmes, ce qui est le contraire du but recherché. J'espère que cet article vous a aidé à éviter ce destin.

image d'en-tête avec la permission de DKNG

Avatar

Bogdan Rancea

Bogdan est un membre fondateur d’Inspired Mag, ayant accumulé près de 14 années d’expérience 6 au cours de cette période. Dans ses temps libres, il aime étudier la musique classique et explorer les arts visuels. Il est également obsédé par les fixies. Il possède déjà 5.