Convention de nommage

Problème

A chaque fois qu’il faut nommer une entité dans le code, quelle structure et quelle forme (notamment au sujet de la casse) respecter ?

Pas question de se poser la question à chaque fois.

Solutions

Casse des noms

Adopter et partager une casse adaptée au langage, ou aux types d’entités manipulées.

Il existe plusieurs style de casses : camel case, snake case, et d’autres comme présentées ici : (en) Snake Case VS Camel Case VS Pascal Case VS Kebab Case – What's the Difference Between Casings?.

camelCase

snake_case

Plus sur l’implémentation de cette solution en JavaScript/TypeScript, PHP, CSS et HTML plus bas dans l’article.

Préfixes

Parfois préfixer le nom de la variable par son type.

interface IUser

Note : concernant le “_” underscore, celui-ci peut-être utilisé pour préfixer un attribut privé ou protégé, une variable masquée dans un module (telle qu’un cache), ainsi que ponctuellement avec un nom de dossier agrégeant des instances d’un motif, ou un nom de variable temporaire.

private _updatedAt

let _cache

_mocks/

const _users = [ …users ]

Suffixes

Parfois suffixer le nom du fichier par son type.

authentification.spec.ts

En JavaScript et TypeScript

De mon expérience, la casse gagnante en JS/TS est le camel case :

On l’utilise pour les noms de variables, de fonctions, souvent pour les noms de fichiers.

Pour les classes, types et composants, on utilise plutôt du pascal case.

Pour les constantes et énumérations, on utilise du snake case majuscule.

On peut parfois utiliser du kebab case pour nommer des dossiers et des fichiers.

En PHP

En PHP, la plupart des noms de variables, fonctions, fichiers sont en snake case.

Les classes sont en pascal case.

Les constantes en snake case majuscule.

En HTML

C’est le kebab case qui règne en HTML : il est utilisé pour le nom de balises et des attributs.

En CSS

En CSS, les sélecteurs et les règles s’écrivent en kebab case.

Note : dans du CSS géré par JS, le nom des règles passent en camel case.

Relations