Un court guide sur le nommage des composants
by Angela Fisher, Développeuse Front-end
1. La brièveté est la clé
Le temps est précieux, ne le gaspillez pas à taper de longs noms descriptifs pour vos composants. Une approche consiste à leur donner des noms courts et cryptiques que vous seul comprendrez.
Besoin d’un bouton ? Appelez-le "btn". Une modale ? Que diriez-vous de "mdl" ? Vous économiserez de précieuses minutes par jour et vous aurez l’avantage supplémentaire d’être la seule personne dans la base de code qui sait où se trouve quoi. Cela s'appelle la sécurité de l'emploi.
2. Être bien classé dans les recherches
Lorsque vous travaillez dans de grands dépôts avec beaucoup de collaborateurs, il est important que votre composant soit bien classé lorsque les gens recherchent quelque chose.
Un moyen de se démarquer est d’inclure tous les termes de recherche possibles dans le nom de votre composant. Au lieu de “SignInButton”, vous pourriez l'appeler “SignInButtonAuthenticationCookieUserLogIn” ce qui garantira qu’il est retourné dans presque tous les résultats de recherche connexes.
3. Mélanger les langues
Si vous travaillez à distance, il est probable que vous faites partie d’une équipe mondiale et pourtant tous vos composants ont des noms anglais. Cela ralentit considérablement vos collègues non anglophones, donc vous devriez leur permettre d’utiliser leur langue maternelle lors du nommage des composants.
Vous pouvez créer un fichier d'index qui mappe toutes les différentes langues dans votre dépôt. Besoin d’un menu déroulant ? Cherchez “Desplegable”. Un formulaire ? Recherchez “Форма”. Vous apprendrez plusieurs nouvelles langues tout en étant plus inclusif envers vos collègues.