12 règles pour faire du clean code

Ces 12 règles de codage pour faire du clean code sont un ensemble de style directives pour la programmation. Les meilleures pratiques et principes de programmation font partie de ces 12 règles pour faire du clean code. Nous aborderons ici ces quelques règles de codage.

Avantages de suivre ces règles :

  • Clean code
  • Qualité du code
  • Lisibilité du code
  • Facilité de la maintenance du code

12 règles pour faire du clean code

1. Nombres magiques

Un nombre magique signifie que nous attribuons un nombre sans signification claire. Parfois, nous utilisons une valeur dans un but précis, cependant nous ne l’affectons pas à une variable significative. Le problème est que lorsque quelqu’un travaille avec votre code, il ne connaît pas la signification de cette valeur directe.

Nombres magiques All4Test

2. L’imbrication profonde

Parfois, nous intégrons des éléments qui sont difficiles à comprendre. La façon de gérer cela est d’extraire toutes les parties dans des structures séparées.

Supposons que nous ayons un tableau, dans un autre tableau qui contient un autre tableau et dont nous voulions la valeur du dernier tableau. Nous pouvons écrire des éléments qui répondront à nos besoins. Mais ce n’est pas la bonne méthode car peut-être difficiles à comprendre. 

Voici l’exemple ci-dessous avec une fonction qui peut faire la même chose, mais celle-ci est beaucoup plus propre, plus simple, moins répétitive, plus facile à lire et réutilisable.

L’imbrication profonde All4Test

3. Commentaires

Les commentaires permettent d’aider les gens à mieux comprendre le code plus tard dans le temps, de même manière ils aident d’autres programmeurs à collaborer sur le même projet. Toutefois, les commentaires dans le code désigne peut-être que votre code n’est pas assez clair.

Les commentaires sont une bonne chose, mais votre code doit être assez clair. 

4. Évitez les grosses fonctionnalités

Lorsqu’une fonctionnalité ou une catégorie est volumineuse, il est suggéré de la séparer en plusieurs parties. Cela rendra le code plus facile à comprendre, propre et également réutilisable.

Supposons que nous ayons besoin d’additionner et de soustraire deux nombres. Nous pouvons le faire avec une seule fonction. Mais la bonne méthode consiste à les diviser en deux. S’il y a des fonctionnalités individuelles, elles pourront être réutilisées et plus simple à comprendre. 

Évitez les grosses fonctionnalités All4Test

5. Répétition de code

Le code répété signifie un ensemble de code qui est repris plus d’une fois. Cela signifie que votre bloc de code nécessite une fonction.

Dans l’exemple utilisé au chapitre 2, la première partie nous répétons la même chose trois fois. 

La solution consiste à créer une fonctionnalité individuelle pour plus d’efficacité et peut également être réutilisée.

Répétition de code All4Test

6. Noms des variables

“Camel case” est la règle pour désigner des variables et des fonctions, ainsi que d’autres éléments. 

Cela signifie qu’un nom est censé commencer par une petite lettre et que chaque première lettre du mot suivant commencera par une majuscule.
La fonction et la variable doivent toutes deux respecter cette règle.

Noms des variables All4Test

7. Noms significatifs

Un nom significatif est l’une des conventions les plus importantes. Utilisez toujours un nom significatif pour les variables, les fonctions et autres. Choisissez un nom qui exprime le sens de votre objectif.

Si nous avons besoin d’une fonction qui obtiendra les informations bancaires de l’utilisateur, nous ne devons pas utiliser un nom comme « getUserInfo« . Nous devons utiliser « getUserBankInfo » pour être plus précis.

8. Privilégier le détail plutôt qu’un résumé

Essayez d’utiliser des détails pour chaque désignation. Imaginons que nous ayons besoin d’une fonctionnalité qui permette de trouver un utilisateur grâce à son téléphone. Dans ce cas, nous pouvons utiliser des noms concis, mais le risque d’erreur est élevé s’il existe d’autres fonctionnalités similaires.

Nous devons utiliser un nom détaillé et précis qui exprime le sens en quelques mots.

Privilégier le détail plutôt qu’un résumé All4Test

9. Utiliser des verbes cohérents pour chaque concept

C’est la règle de désignation la plus importante. Si nous avons besoin d’une fonction CRUD, nous utiliserons “create”, “get” ou “update” pour la désigner.

Si nous devons obtenir des informations sur un utilisateur à partir de la base de données, alors le nom de la fonction peut être “userInfo”, “user” ou “fetchUser”, mais cette règle est fausse. Nous devrions plutôt utiliser “getUser”.

Utiliser des verbes cohérents par concept All4Test

10. Utiliser des noms pour le nom de classe et utiliser le “Pascal Case”

La catégorie est avant tout un modèle pour quelque chose. Cependant ne pas utiliser de verbes pour les catégories.

D’un autre côté, une catégorie devrait utiliser le “Pascal case” pour les objets !

11. Mettre les valeurs constantes en majuscules (SNAKE UPPER CASE)

Voici une autre règle à respecter pour faire du clean code. Utilisez toujours des noms en majuscules pour les constantes.

“Snake uppercase” signifie que toutes les lettres seront en majuscules et qu’un trait viendra séparer tous les mots.

Mettre les valeurs constantes en majuscules All4Test

12. Évitez les noms de variables à une lettre

Une variable d’une lettre est une très mauvaise chose à faire. Ne pas l’utiliser pour un nom de variable, mais dans une séquence, nous pouvons utiliser certaines variables avec une lettre, ceci est correct.

Évitez les noms de variables à une lettre All4Test

Savez-vous que l’approche clean code, peut s’appliquer à votre code d’automatisation des tests ?
En effet, cette approche vous permettra d’avoir du code plus facilement maintenable et compréhensible pour l’équipe en charge de la maintenance du Framework d’automatisation de test.

Si vous souhaitez en savoir plus et être accompagné sur le sujet, découvrez l’offre CLEAN TEST mise en place par ALL4TEST et des coachs crafts.

Source : https://betterprogramming.pub/12-conventions-for-writing-clean-code-e16c51e3939a