Comment avoir un code de qualité : le nommage

Lorsque vous commencez à coder, vous passez généralement un an ou deux à ignorer complètement les règles de "bon code". Vous pouvez entendre des mots comme "élégant" ou "propre", mais vous ne pouvez pas les définir. Ce n'est pas grave. Pour un programmeur sans expérience, la principale métrique à surveiller est "Est-ce que ça marche ?"

Mais bientôt, vous devrez augmenter vos attentes. Un bon code ne fonctionne pas seulement. Il est simple, modulaire, testable, maintenable, réfléchi. Certains de ces termes peuvent s'appliquer à votre code sans que vous le sachiez. Si vous avez de la chance, votre équipe d'architectes et de concepteurs planifie avec soin des solutions de code et vous guide en douceur, en vous faisant confiance pour développer une intuition d’un logiciel bien écrit. Si vous n'avez pas de chance, ils grimacent ou se plaignent chaque fois qu'ils voient votre code. Quoi qu'il en soit, l'apprentissage de quelques principes universels peut vous apporter beaucoup.

Un code qui fonctionne mais sans être simple, modulaire, testable, maintenable ou réfléchi est appelé spaghetti code en opposition au clean code.

La différence entre un "bon code" et un "mauvais code" n'est généralement pas basée sur la manière dont il vous affecte quand vous l'écrivez. Le code est toujours une ressource partagée : vous le partagez avec d'autres contributeurs de logiciels open-source, ou avec les autres développeurs de votre équipe, ou avec la personne qui aura votre poste à l'avenir, ou avec le "futur vous" (qui n'aura pas la moindre idée de ce que le "présent vous" pensait), ou même juste avec "debugging vous", qui parcourt votre nouveau code à la recherche de bugs et est totalement frustré.

Toutes ces personnes vous seront reconnaissantes si votre code a un sens. Cela leur facilitera la tâche et réduira le stress. Ainsi, la rédaction d'un bon code est une forme de courtoisie professionnelle.

La Dénomination (nommage)

L'un des problèmes les plus courants des développeurs est la dénomination. Je ne sais pas compter, combien d'heures j'ai passé à réfléchir à la façon de nommer les choses et combien d'heures il m'a fallu pour comprendre le code contenant des noms erronés. Peu importe qu'il s'agisse d'un objet, d'une méthode, d'une classe ou de quoi que ce soit d'autre. Il est prouvé que nous passons plus de temps à lire du code qu'à l'écrire, donc un bon nom est toujours payant à l'avenir.

L'utilisation de bons noms rend votre code meilleur et plus propre. Cela vous aide à identifier intuitivement les responsabilités de chaque partie du code. Cela rend votre application facile à lire à l'avenir par les autres développeurs, ainsi que par vous-même.

Les conventions de nommage

Dans cette sections nous allons voir quelques conventions de nommage, utilisées de manière générale en informatique, par convention j’attends ce qui est admis d'un commun accord, tacite ou explicite, il faut savoir que les conventions de nommage uniformisent le code, ce qui a l'avantage de permettre aux développeurs de trouver plus facilement et rapidement les noms utilisés dans un projet et de collaborer plus facilement lorsque le code est écrit par plusieurs personnes.

Supprimer les espaces entre les mots

En programmant, nous supprimons souvent les espaces entre les mots parce que des programmes de différentes sortes réservent le caractère espace (' ') à des fins spéciales. Comme le caractère espace est réservé, nous ne pouvons pas l'utiliser pour représenter un concept que nous exprimons dans notre langage humain avec plusieurs mots.

À titre d'exemple, le concept de nombre de connexions d'utilisateurs n'est pas référencé dans notre code comme user login count souvent. Nous ne faisons pas ce qui suit :

$user login count = 5;

Un parseur de code classique considère chaque mot comme un concept distinct. L'utilisateur, le login et le compte seraient chacun traités comme des choses distinctes. Donc, nous faisons quelque chose comme ce qui suit :

$userLoginCount = 5;

Le parseur de code voit maintenant un concept, $userLoginCount, et nous, les programmeurs, pouvons facilement voir la représentation.

La meilleure façon de combiner les mots

Il n'y a pas de meilleure façon de combiner les mots. Dans l'exemple ci-dessus, nous avons supprimé les espaces et mis en majuscules chaque mot suivant le premier mot, Il existe cependant un grand nombre d'algorithmes pour combiner les mots, et quelques-uns sont très courants. Les stratégies couramment utilisées pour combiner les mots sont :

• Camel case

• Pascal case

• Snake Case

• Kebab Case

Le Camel case (de l'anglais, littéralement « casse de chameau ») est une pratique qui consiste à écrire un ensemble de mots en les liant sans espace ni ponctuation, et en mettant en capitale la première lettre de chaque mot.

Exemple : user login count en Camel case sera userLoginCount

C'est une façon très populaire de combiner des mots pour former un seul concept. Elle est souvent utilisée comme convention dans les déclarations variables et fonctions dans de nombreux langages de programmation.

Le Pascal case combine les mots en mettant tous les mots en majuscules (même le premier mot) et en supprimant l'espace, comme suit :

user login count en Pascal case sera UserLoginCount

C'est aussi une façon très populaire de combiner des mots pour former un seul concept. Elle est souvent utilisée comme convention pour déclarer les classes dans de nombreux langages de programmation.

Le snake case combine les mots en remplaçant chaque espace par un trait de soulignement (_) et, dans la version tout en majuscules, toutes les lettres sont en majuscules, comme suit :

• user login count en snake case sera user_login_count

• user login count en snake case sera USER_LOGIN_COUNT

Ce style, lorsqu'il est en majuscule, est souvent utilisé comme convention pour déclarer des constantes. En minuscules, il est utilisé par convention pour déclarer les noms des champs de la base de données par exemple.

Le kebab case combine les mots en remplaçant chaque espace par un tiret (-), comme suit :

user login count en kebab case sera user-login-count

Ce style est souvent utilisé dans les URL. Par exemple, www.blog.com/cool-article-1. C'est une façon agréable, propre et lisible de combiner les mots.

Conclusion

Il n'y a pas de meilleure méthode pour combiner les mots. L'essentiel est d'être cohérent avec la convention utilisée et, si vous êtes en équipe, de parvenir ensemble à un accord sur la convention.