Assurance qualité
Logicielle

Nommage

Introduction

Les conventions de nommage contrôle tout endroit dans le code où vous pouvez choisir le nom d'un élément. Vous les utiliserez donc pour les éléments suivant:

  • Variables
  • Constantes
  • Fonctions et méthodes
  • Classes et Interfaces

Il est possible que vous n'ayez pas vu certains concepts dans cette liste. Si c'est le cas, ne stressez pas. Vous verrez ces concepts très bientôt et vous serez déjà en mesure de bien les nommer.

Type de casse

Pour le nommage, nous utilisons souvent des types de casse spécifique dépendemment de ce que l'on essait de nommer. La casse est notre façon d'écrire les identifiants pour être capable de bien les lire et comprendre. Comme les identifiants dans un code source sont dans un seul mot (il n'y a pas d'espaces), on utilise les majuscules, minuscules ou autres caractères pour être en mesure de bien les distinguer. Voici typiquement les différentes casse que nous utiliserons pour les conventions de nommage:

Camel Case
C'est la casse où chaque mot dans l'identifiant commence par une majuscule. On le nomme ainsi puisque les lettres majuscules crées des bosses dans l'identifiant, comme sur le dos d'un chameau.
Texte
Camel Case commençant par une minuscule
C'est la même casse que le Camel Case, mais la première lettre de l'identifiant est une lettre minuscule.
Texte
Snake Case majuscule
C'est une casse où l'on utilise la barre de soulignement _ pour séparer les mots dans l'identifiant. Tous les autres caractères sont en majuscules. On le nomme ainsi puisque les identifiants ressemble au déplacement en zigzag des serpents.
Texte
Snake Case minuscule
Même principe que le Snake Case majuscule, mais toutes les lettres sont en minuscules. On utilise moins cette casse en programmation, mais elle est utilisé dans certains standards de base de données.
Texte
Kebab Case
C'est une casse similaire au Snake Case, mais tous les mots sont séparé par des tirets -. Cette casse est beaucoup utilisé dans la création d'identifiant en programmation web. On le nomme ainsi puisque les mots de nos identifiants semblent être sur une broche.
Texte

Variables et constante

Dans la majorité des langages de programmation modernes et encore utilisés, les noms de variable vont toujours utiliser le Camel Case commençant par une lettre minuscule.

C#

Les constantes, quant à elles, utiliseront généralement le Snake Case en majuscule.

C#

Fonctions et méthodes

La casse utilisé par les fonctions et méthodes dépendent du langage de programmation. Le Camel Case commençant par une minuscule est généralement utilisé, mais certains langages, comme le C#, utilise le Camel Case de base. Dans tous les cas, une forme de Camel Case est utilisé.

Javascript
C#

Classes et Interfaces

Les classes et interfaces, dans presque tous les langages de programmation modernes, utiliseront le Camel Case pour leur identifiant. Il est important de noter que les interfaces commenceront généralement par la lettre I pour bien indiquer que c'est une interface.

C#
C#

Noms significatifs

Lors du choix d'un nom pour un identifiant, il est très important de définir un nom clair et précis. La plupart des langages de programmation ne limitent pas le programmeur sur la taille d'un identifiant. Vous pouvez, par conséquent, être très précis dans son nommage.

À moins d'être dans la déclaration d'une boucle for, évitez les noms de variable courts comme a, b ou xx. Évitez les acronymes qui ne sont pas très connu comme itac ou pj1.

Utilisez plutôt des mots complets et clairs que vous utiliserez avec casse. N'hésitez pas à mettre un long nom de variable si celà aide à la compréhension du code. Le nom de la variable doit être en mesure de nous indiquer aisément ce qu'elle contient, même pour une programmeur qui ne travaille pas sur le projet. Par exemple, au lieu de pj1, écrivez positionJoueur1.