Conventions de nommage (Pascal et Camel)

Bonjour à tous,

Pour rendre vos programmes compréhensibles, il est important de bien choisir les noms de éléments. Cela inclut la dénomination des variables, méthodes, classes, énumérations, et espaces de noms.

Intuitivement, on peut dire que les noms devraient refléter la destination de l'élément et n'entrer en conflit avec aucun autre nom. Dans le .NET Framework, la philosophie générale de la dénomination des variables suggère que le nom de la variable devrait refléter l'emploi de l'instance de cette variable et non le type de données. Par exemple, Hauteur est un bon nom de variable alors que Valeur-Entiere ne l'est pas.

Abordons ce qui devrait vous préoccuper lors du choix des noms.

Casse des noms

Dans à peu près tous les cas, utilisez la casse Pascal pour les noms. La casse Pascal signifie que la première lettre de chaque mot du nom est une majuscule : SalaireEmploye, CodagePlainTexte, BoiteConfirmation. Vous remarquerez qu'essentiellement tous les noms d'espaces de noms, de classes et les membres de classes de base suivent la casse Pascal. En particulier, la convention de réunir les mots par un soulignement bas (underscore) est découragée. Vous ne devriez donc pas utiliser des noms comme Salaire_Employe. Dans d'autres langages, il était habituel d'utiliser des noms de constantes intégralement écrits en majuscules. Ce n'est pas conseillé en C#, ces noms sont plus difficiles à lire. Utilisez plutôt la casse Pascal :

Code:

const int MaximumLength;

Le seul autre schéma de casse que nous conseillons d'employer est la casse Camel. La casse Camel est identique à la casse Pascal si ce n'est que la première lettre du premier mot du nom n'est pas une majuscule : salaireEmploye, boiteConfirmation, codagePlainTexte. Il existe deux situations où nous conseillons d'utiliser cette classe Camel :

• Les noms de tous les paramètres passés à une méthode devraient être en casse Camel :
  

  Code:

  public void RecordSale(string salesmanName, int quantity)
  {
      // ...
  }

• Vous devriez utiliser la casse Camel pour établir une distinction entre deux éléments qui, autrement, auraient le même nom. Exemple habituel, lorsqu'un propriété encapsule un champ :
  

  Code:

  private string employeeName;
  public string EmployeeName
  {
      get { return employeeName; }
      set { employeeName = value; }
  }

  Une autre convention largement utilisée dans RunUO est de préfixer le nom du champ encapsulé dans une propriété par une lettre minuscule suivie d'un soulignement bas (underscore) :
  

  Code:

  private string m_Name;
  public string Name
  {
      get { return m_Name; }
      set { m_Name = value; }
  }

En ce qui concerne les conventions, le code précédent est acceptable. Remarquez, cependant, que si vous suivez cette méthodologie, vous utiliserez toujours la casse Camel pour le membre privé et la casse Pascal pour le membre public ou protégé. De ce fait, les autres classes employant le code verront uniquement les noms en casse Pascal (sauf les noms de paramètres).

Restez attentif à la sensibilité à la casse. C# est sensible à la casse et il est admis du point de vue syntaxe d'avoir des noms C# différant uniquement par la casse, comme dans l'exemple précédent (avec employeeName et EmployeeName). Cependant, d'autres langages qui peuvent faire appels à vos classes écrites en C# ne le sont pas, ce pourquoi il est conseillé de distingué les noms d'une autre façon que par la casse (d'où l'intérêt d'une minuscule suivie d'un underscore en préfixe au nom).

Pour plus de détails je vous renvoie au PDF suivant où les conventions de nommage sont abordées au point 8 (le reste est aussi très intéressant).
http://www.icsharpcode.net/technotes/sharpdevelopcodingstyle03.pdf


Sources externes utilisées pour l'écriture de l'article :
- C# Professionnel 2e édition, Edition CampusPress