Conventions de dénomination JavaScript: à faire et à ne pas faire

Je trouve incroyable le nombre de significations différentes que nous pouvons obtenir à partir de moins de 30 caractères. Je parle de l'alphabet avec une ponctuation bien placée, bien sûr. D'une histoire d'amour à un programme informatique, l'écriture nous a permis de créer des mondes extraordinairement différents. Et la langue, en général, fournit un cadre dans lequel nous pouvons accrocher un flux d'idées.

La plupart des langages de programmation semblent avoir des normes très strictes - certains termes doivent être utilisés à certains endroits. Mais un domaine où il y a énormément de liberté est la façon dont nous nommons ces termes.

Prenez ce programme simple qui crée une phrase à partir d'un tableau de mots, ajoute un signe de ponctuation et l'enregistre dans la console:

Rien de bien spécial, non? Mais ce que vous n'avez peut-être pas pris en compte, c'est combien de termes vous étiez responsable de nommer.

Il y a 23 mots (sans compter les valeurs codées en dur) dans le programme ci-dessus. Nous avons contrôlé les noms de 14 de ces mots. C'est plus de 60% de ce qui a été tapé, c'était notre responsabilité de nommer!

Que vous construisiez une application d'entreprise ou un simple Hello, World, vous voulez que votre programme se lise comme un Times Bestseller, pas comme un classeur Mad Libs.

Ce n'est pas un manifeste sur la façon de structurer une application JavaScript entière, mais plutôt un chapitre sur la façon de choisir des noms pour les choses dans lesquelles vous avez la liberté de le faire. J'ai inclus les différentes références en bas si vous voulez en savoir plus. Une dernière chose, la clé à retenir de toutes nos conventions et normes est la suivante:

La plupart de ces conventions ne sont pas pour vous aujourd'hui, mais plutôt pour vous et les personnes qui liront votre code demain.

Références et formation continue

  1. «Clean Code» par Robert C. Martin - Une excellente lecture pour toutes les langues. Il va au-delà des conventions de nommage et propose toute la structure de votre programme. Les exemples sont en Java, mais les principes s'appliquent à JavaScript.
  2. «Clean Code JavaScript» par Ryan Mcdermott - Le livre ci-dessus, mais refait pour JavaScript. Il est disponible en ligne et est gratuit.
  3. Airbnb JavaScript Style Guide - Peut - être le guide de style le plus complet pour JavaScript. Il contient non seulement le quoi, mais aussi le pourquoi. (Si vous utilisez un petit appareil, vous devrez peut-être cliquer sur «Afficher tout le fichier Lisez-moi» pour voir le document entier).
  4. W3 JavaScript Style Guide - Un guide court et concis.
  5. Guide de style ES6 de Google - Guide de style de Google pour JavaScript.

Merci d'avoir lu!

woz

Suis moi sur Twitter.