Choisir des noms de variables qui suivent les règles et les conventions

6 minutes

Un développeur de logiciels a dit une fois célèbre : « La partie la plus difficile du développement de logiciels est de nommer des choses. » Non seulement le nom d’une variable doit-il suivre certaines règles de syntaxe, il doit également être utilisé pour rendre le code plus lisible et compréhensible. C’est beaucoup à demander à une seule ligne de code !

Règles de nom de variable

Il existe des règles de nommage de variables appliquées par le compilateur C#.

Les noms de variables peuvent contenir des caractères alphanumériques et le caractère de soulignement (_). Les caractères spéciaux comme le signe dièse (#), le tiret (-) et le symbole du dollar ($) ne sont pas autorisés.
Les noms de variables doivent commencer par une lettre alphabétique ou un trait de soulignement, et non par un nombre. L’utilisation d’un caractère de soulignement pour démarrer un nom de variable est généralement réservée aux champs d’instance privée. Vous trouverez un lien vers une lecture plus poussée dans le résumé du module.
Les noms de variables ne doivent PAS être un mot clé C#. Par exemple, ces déclarations de nom de variable ne seront pas autorisées : float float; ou string string;.
Les noms de variable respectent la casse. Ainsi, string MyValue; et string myValue; sont deux variables différentes.

Conventions des noms de variables

Les conventions sont des suggestions qui sont acceptées par la communauté de développement de logiciels. Bien que vous soyez libre de décider de ne pas suivre ces conventions, ils sont si populaires qu’il peut rendre difficile pour d’autres développeurs de comprendre votre code. Vous devez pratiquer l’adoption de ces conventions et les faire partie de vos propres habitudes de codage.

Les noms de variables doivent utiliser le format camelCase, qui est un style d’écriture commençant par une lettre minuscule pour le premier mot et une lettre majuscule au début de chaque mot subséquent. Par exemple : string thisIsCamelCase;.
Les noms de variables doivent être descriptifs et explicites dans votre application. Vous devez choisir un nom pour votre variable qui représente le type de données qu’elle contiendra (et non le type de données). Par exemple : bool orderComplete;, NOT bool isComplete;.
Les noms de variables doivent être un ou plusieurs mots entiers ajoutés ensemble. N’utilisez pas de contractions, car le nom de la variable peut ne pas être clair pour d’autres personnes qui lisent votre code. Par exemple : decimal orderAmount;, NOT decimal odrAmt;.
Les noms de variables ne doivent pas inclure le type de données de la variable. Vous pouvez voir quelques conseils pour utiliser un style comme string strMyValue;. C’était un style populaire il y a des années. Toutefois, la plupart des développeurs ne suivent plus ces conseils et il existe de bonnes raisons de ne pas l’utiliser.

L’exemple string firstName; suit toutes ces règles et conventions, en supposant que vous souhaitez utiliser cette variable pour stocker les données qui représentent le prénom d’une personne.

Exemples de noms de variables

Voici quelques exemples de déclarations de variables (à l’aide de types de données courants) :

char userOption;

int gameScore;

float particlesPerMillion;

bool processedCustomer;

Autres conventions d’affectation de noms

Les règles et conventions décrites ci-dessus concernent les variables locales. Une variable locale est une variable délimitée dans le corps d’une méthode ou une variable dans une application console qui utilise des instructions de niveau supérieur (comme le code de ce module).

Il existe d’autres types de constructions que vous pouvez utiliser dans vos applications, et beaucoup ont leurs propres conventions. Par exemple, les classes sont souvent utilisées dans la programmation C# et ont des conventions associées. Bien que vous ne créez pas de classes dans ce module, il est important de savoir que les conventions d’affectation de noms que vous venez d’apprendre sont adaptées à une infrastructure d’affectation de noms plus grande.

Commentaires

Cette page a-t-elle été utile ?

Choisir des noms de variables qui suivent les règles et les conventions

Vérifier vos connaissances

Commentaires