Nommer ses variables

Soyons honnête, la programmation peut être ardue par moment. Un bon moyen de se simplifier la vie et d'éviter des erreurs de base est de bien nommer ses variables.

Idéalement un nom de variable devrait-être descriptif de ce qu'il contient. Quitte à le rendre plus long.

Règles générales

À éviter 🚫

• Noms d'une seule lettre
  const a; Qu'est-ce que a? 😱

• Acronymes
  const arc; Agence du revenu du 🇨🇦, vous auriez deviné?

• Abréviations
  const cat; Comme dans 🐈 ou catégorie?

• Noms vides de sens
  const thing; Mais encore…

• Métaphores
  const killSwitch; Reset du formulaire ou X du popup? 🧐

• Mix de langues
  const flecheBlue; Ou est-ce bleuArrow? 🤦‍♂️

Booléen

Une variable de type booléen est facilement identifiable lorsqu'elle est préfixée par un statut se répondant par vrai ou faux.

Par exemple: is, has ou can.

À éviter 🚫

let person = true;
let access = true;
let move = true;

Avec un préfix 👌

let isPerson = true;
let hasAccess = true;
let canMove = true;

Négation 🚫

Il est aussi important d'éviter les négations pour diminuer la charge cognitive requise afin de comprendre la variable.

Par exemple, c'est deux variables veulent dire la même chose, mais la première le fait avec une négation ajoutant une charge cognitive.

// Négation
let isNotActive = false;

// Sans négation
let isActive = true;

Tableau

Une variable de type tableau est facilement identifiable lorsqu'elle contient un suffixe reflétant son contenu.

Par exemple: arr ou list.

Utiliser le terme pluriel afin d'identifier qu'il s'agit d'un tableau est une approche valide, mais risqué. Une seule lettre de différence entre deux variables offre un contraste faible, les rendant propices à être interverties.

Qui plus est, certains mots sont immuables au pluriel, rendant cette approche étrange parfois.

Par exemple: le terme pantalon en anglais au singulier pants ou au pluriel pants👖.

À éviter 🚫

• const news; Contient une ou de plusieurs nouvelles? 🤔

Avec un suffix 👌

• const newsArr; Ahhh, un tableau de nouvelles 📰

Objet

Une variable de type objet est facilement identifiable lorsqu'elle contient un suffixe reflétant son contenu.

Par exemple: obj.

À éviter 🚫

• const user; Est-ce un nom, un id, un objet? 🤷‍♂️

Avec un suffix 👌

• const userObj; Clairement un objet.

Fonction

Une fonction est facilement identifiable lorsqu'elle contient un verbe indiquant quelle tâche elle accomplie.

Par exemple: show, create ou open.

À éviter 🚫

const popup = function() {...};
const user = function() {...};
const menu = function() {...};

Avec un préfix👌

const showPopup = function() {...};
const createUser = function() {...};
const openMenu = function() {...};