Indentation du code [Introduction à JavaScript]

Indentation du code

Objectif

Connaître les conventions d'indentation du code.

Mise en situation

Le métier de développeur ne consiste pas simplement à écrire du code. Il arrive régulièrement qu'il soit nécessaire d'en lire, par exemple pour comprendre le fonctionnement d'un programme. Il est donc important de donner une bonne lisibilité à son code, pour permettre aux autres ou à soi-même de le relire facilement. Pour cela différentes règles doivent être respectées, comme par exemple l'indentation. Elle consiste à ajouter des espaces au début des lignes, pour identifier clairement les différents blocs de code.

Fondamental : Indentation

La lecture d'un code doit être facilitée visuellement par une bonne indentation : c'est une manière de formater les lignes et d'arranger les blocs de code en utilisant un nombre spécifique d'espaces et de tabulations. Le résultat doit permettre d'identifier d'un simple coup d’œil les différents niveaux du code, en particulier lorsque l'on imbrique des blocs dans d'autres.

L'indentation est la plupart du temps esthétique : elle ne fait que mettre en forme le code.

Néanmoins, dans certains langage comme Python elle modifie le sens du contenu.

Exemple : Code non-indenté VS code indenté

// Code mal indenté
let surname = 'First'
let firstname = 'Alexander'
if (surname && firstname) {
console.log('Name :')
console.log(firstname, surname)
}

// Code mal indenté
let surname = 'First'
let firstname = 'Alexander'

if (surname && firstname) {
console.log('Name :')
console.log(firstname, surname)
}

// Code correctement indenté
let surname = 'First'
let firstname = 'Alexander'
if (surname && firstname) {
  console.log('Name :')
  console.log(firstname, surname)
}

// Code correctement indenté
let surname = 'First'
let firstname = 'Alexander'

if (surname && firstname) {
  console.log('Name :')
  console.log(firstname, surname)
}

Grâce à l'indentation on perçoit mieux que les deux affichages console.log dépendent de la condition (if).

Méthode : Règles générales

Bien que le style d'indentation puisse légèrement varier, il existe des conventions populaires :

Utiliser des espaces (qui espaceront de manière identique partout) plutôt que des tabulations (qui pourront rendre un résultat différent selon les environnements).
Utiliser deux espaces pour l'indentation.
À chaque fois qu'un bloc est imbriqué dans un autre, l'indenter avec les 2 espaces supplémentaires.
Ne pas sauter plusieurs lignes entre des instructions.

Méthode : Auto-format

Sur Repl.it, une option permet rapidement de corriger l'indentation du code. Pour cela, cliquer sur l’icône « auto-format » à droite du nom du fichier.

À retenir

L'indentation ne doit pas être négligée car, sans elle, un code peut rapidement devenir difficile à lire et donc à comprendre.