Il est fortement recommandé voir impératif d'appliquer certaines règles en matière de convention typographiques du code de programmation et uniquement dans le but de faciliter la relecture.
Ce document est dédié à vous aider dans cette manœuvre.

Developpez.com vous propose déjà de consulter un fichier de normalisation des noms.

Vous pouvez le télécharger en cliquant ici.
Il s'agit d'un fichier au format Excel qui récapitule la liste des types de contrôles et des variables dont vous trouverez des détails supplémentaires au sein de ce document.

Je tiens à remercier tout particulièrement Demco et Tofalu ainsi que toutes celles et ceux qui ont participé à la relecture de ce document en y incluant leurs remarques.

Pour tous renseignements complémentaires, veuillez me contacter directement (Argyronet) par MP.

La raison majeure qui oblige à respecter cette convention est fondée sur l'objectif de standardiser la structure et le style du code du programme d'un projet ou d'une application afin que vous et tout autre personne faisant partie de votre équipe soient à même de lire, analyser et comprendre plus rapidement le contenu.

Le fait d'appliquer l'écriture de son code avec de telles conventions permet d'obtenir un code source précis, dépourvu d'ambiguïtés et surtout facile à relire.

Ces conventions sont à appliquer pour le cas d'une variable, selon sa portée et d'un objet (Table et ses champs, Formulaire et ses contrôles, Etat et ses contrôles, Module etc...) selon son type.

Cela simplifie grandement le développement en équipe du fait que des normes sont mises en place.
La relecture en est (et restera) que plus aisée. Il faut noter au passage que les conventions de dénomination sont à établir au départ. Une fois le développement réalisé, il est difficile de revenir en arrière pour intervenir sur le code dans le seul but d'appliquer ces conventions.

Il existe des normes et des conventions préétablies pour nommer les objets de contrôle, les variables, les procédures et les constantes et tous les objets faisant partie du code.
Ces normes sont issues de règles logiques qui permettent en un seul coup d'oeil de repérer ce à quoi on a à faire sans qu'il soit forcément nécessaire de partir à la recherche de la source de l'objet concerné.

Terminologie des noms d'objets

De manière générale, un objet de contrôle doit obligatoirement être renommé (par défaut un objet de contrôle porte le nom du type de contrôle suivit d'un numéro incrémenté).

Par exemple:
- Liste13
- Étiquette47
- Texte14
- Commande23

La terminologie standard d'un nom d'objet peut être scindée au minimum en 2 parties et au maximum 4.

La terminologie en 2 parties pour les noms d'objets se compose comme suit:
[Une étiquette]Le Nom de l'Objet

La terminologie en 3 parties pour les noms d'objets se compose comme suit:
[Le Préfixe][Une étiquette]Le Nom de l'Objet

La terminologie en 4 parties pour les noms d'objets se compose comme suit:
[Le Préfixe][Une étiquette]Le Nom de l'Objet[Le Suffixe]

Pour appliquer la terminologie d'un objet, il suffit de se référer au tableau que vous trouverez sur le site ici ou dans ce même document là.
Ce qui est délimité par des crochets est facultatif. Toutefois, cela ne rejoint plus alors l'objectif de ce document.

Définition du Préfixe
Le préfixe a pour rôle d'identifier le type de l'objet:
- On préfixera les objets contrôles mais on apposera pas d'étiquette
- On préfixera les objets tables, requêtes, formulaires...
- On préfixera les objets de type modules et classes...

Quelques préfixes pour un objet de type contrôle
- lbl => Label : Étiquette (Ne pas confondre avec l'étiquette de nommination)
- txt => Textbox : Zone de texte
- cmd => CommandButton : Bouton de commande
- shp => Shape : Forme dessinée (rectangle, cercle...)
- cbo => Combobox : Liste modifiable
- lst => Listbox : Zone de Liste
etc...

Quelques préfixes pour un objet d'application
- tbl => Table : Table
- qry => Query : Requête ou Vue
- frm => Form : Formulaire
- rpt => Report : État
- mcr => Macro : Macro
- bas => Module : Feuille de module
- cls => Classe : Feuille de classe
- cmb => CommandBar : Barre de commande
- mnu => Menus : Barre de menus
etc...

Définition de l'Étiquette pour un objet de type contrôle
Il n'est pas utile de poser une étiquette pour un contrôle car l'étiquette définie la catégorie. Or, pour un contrôle, le préfixe définissant déjà son type, cela est amplement suffisant.

Définition de l'Étiquette pour un objet d'application
Une étiquette est un identificateur de catégorie de l'objet mêlant ainsi le rôle de l'objet ou ce à quoi il est destiné.
Une étiquette n'aura pas plus de 3 ou 4 caractères et sera représentée par un abrégé conventionnel.

A) Par exemple, pour un objet de type Table, on peut imaginer qu'une table de relation soit située comme table intercalée entre une table principale et une table intermédiaire. Elle doit pouvoir alors être identifiée comme telle.



L'étiquette REL définit le fait que la table est une Table de Relation même si l'on devine par son Nom d'Objet que la table sollicite les clients (Customers) et l'historique de ces derniers (History).

B) Un autre exemple, relatif à un objet de type requête (Query), où l'on peut étiqueter la requête par son rôle ;
Par exemple, le nom qrySumOrderAmountsForFrance où Sum est l'étiquette qui définit qu'il s'agit d'une requête avec une clause GROUP BY et où le Nom de l'Objet informe que cette requête renvoie le total des montants des commandes pour la France.

Définition du Nom de l'Objet
Le nom de l'objet sera aussi explicite que possible tout en respectant une limite de caractères.
Il commencera toujours par un caractère alphabétique et sera (exceptionnellement) greffé de caractères de soulignement (_) et surtout pas d'espaces. De plus, on apposera une MAJUSCULE à la première lettre de chaque mot qui le constitue.

Exemple:

Définition d'un Suffixe
Le suffixe est très optionnel et reste utile pour marquer la différence entre deux objets qui ont le même rôle, le même type mais n'attaquant ou ne retournant pas les mêmes données. Par exemple, il est fréquent de rencontrer des contrôles texte répétés pour un numéro de téléphone ou une adresse:

txtAddresse1 et txtAdresse2 où 1 et 2 sont les suffixes au même titre que PhoneNumber1 et PhoneNumber2

Un autre exemple de suffixe, plus précis cette fois, issu d'un nom d'objet qui définit la liste des codes postaux et des villes au sein d'un contrôle ListBox ; comme vous le savez, un contrôle ListBox possède un grand nombre de propriétés mais la plus importante est sa source de contrôle qui lui sert à renvoyer les données.
Cette source de contrôle se traduit
- soit par une clause SELECT inscrite directement dans la zone prévue à cette effet,
- soit par la sélection d'un objet source, en l'occurrence une requête ou une table.

Pour cet exemple, il s'agit bien entendu d'une requête...
Ci-dessous, vous pouvez constater que selon l'intitulé du bouton [Code postal / Ville] ou [Ville / Code postal] la liste inverse et propose respectivement les codes postaux ou les villes en conséquence des caractères tapés dans le contrôle Textbox au-dessus.

Programmaticalement pour chacun des cas, le contrôle fait appel à deux requêtes que j'ai nommées dans un cas
qryCmbListGetOneTown_CPTown
et dans l'autre
qryCmbListGetOneTown_TownCP.

La requête source a pour objectif de renvoyer les mêmes données avec un suffixe différent, donc un ordre de colonne différent.
Vous pouvez alors remarquer que le nom que j'ai donné à ma requête est composée de 4 parties :

Terminologie des noms de variables

De manière générale, une variable est nommée en deux parties
La terminologie standard d'un nom de variable peut être scindée au minimum en 2 parties et au maximum 4 tout comme les objets.
On reprendra alors la composition de la syntaxe comme suit :

La terminologie en 2 parties pour les noms d'objets se compose comme suit :
[Une étiquette]Le Nom de la Variable

La terminologie en 3 parties pour les noms d'objets se compose comme suit :
[Le Préfixe][Une étiquette]Le Nom de la Variable

La terminologie en 4 parties pour les noms d'objets se compose comme suit :
[Le Préfixe][Une étiquette]Le Nom de la Variable[Le Suffixe]

Pour bien comprendre la terminologie d'une variable, il est conseillé de lire la section suivante qui relate de leurs portées. Ce qui est délimité par des crochets est facultatif. Toutefois, cela ne rejoint plus alors l'objectif de ce document.

Définition du Préfixe
Le préfixe a pour rôle d'identifier la portée de la variable :
- On ne préfixera pas les variables de procédures
- On préfixera les variables de modules selon une convention
- On préfixera les variables publiques selon une autre...

Définition d'une Étiquette pour une variable
Une étiquette pour une variable est l'identificateur du type de la variable. Elle permet de déterminer celui auquel elle appartient.
Une étiquette n'aura pas plus de 3 ou 4 caractères et sera représentée par un abrégé conventionnel comme celles présentes dans le tableau récapitulatif suivant :

Pour résumer...
Il est fortement recommandé de s'imposer ces règles. Pour ce qui est de la nomination des préfixes, il est très fréquent de lire du code avec des variables dont le préfixe est tronqué à 1 caractère au lieu de 3.
Sur le plan de la lisibilité, cela n'a pas d'importance si toutefois le développeur a respecté celle-ci dans tout son code.

Exemples:

En revanche, cette nomination mono-caractère ne peut pas s'appliquer facilement pour les variables comme Byte, Collection, Currency, Date, Single... Donc il est préférable de se tenir la convention des 3 caractères.

Dim oExcelApplication as Object
Dim oExcelWorkSheet as Object
Dim oRSTowns as DAO.Recordset
Dim strSQLGetTownList as String
Dim I as Integer

Exemple :

Les variables déclarées dans une procédure ou une fonction

De manière générale, vous devez préfixer les variables déclarées au sein d'une fonction ou d'une procédure avec un préfixe qui en défini le type. Bien que très souvent ces dernières soient dépourvues de tout préfixe, je conseille de passer outre cette dérogation pour une meilleure lisibilité.

Exemple :

Les variables déclarées dans un module

Lorsque vous déclarez des variables de module, la convention universelle propose d'apposer un préfixe m suivi ou non d'un caractère de soulignement (Underscore) suivi du type de la variable et enfin, suivi d'un nom explicite.

Exemple :

Les variables publiques

Lorsque vous déclarez des variables publiques dans un module elles sont exploitées dans l'ensemble du projet ; la convention universelle propose alors d'apposer un préfixe g suivi ou non d'un caractère de soulignement (Underscore) suivi du type de la variable et enfin, suivi d'un nom explicite. Il est envisageable d'adjoindre la lettre v derrière le g afin de préfixer gv devant le nom de la variable ce qui donne alors gv, sous entendu Global Variable.

Exemple :

Les variables de module de classe

Lorsque vous déclarez des variables dans une classe, la convention universelle propose d'apposer un préfixe c ou cls suivi ou non d'un caractère de soulignement (Underscore) suivi d'un nom explicite.

Exemple :

Lorsque vous déclarez des constantes dans un module, la convention universelle propose de les écrire en MAJUSCULE avec un nom explicite dont les mots qui constituent le nom peuvent être séparés par un caractère de soulignement (Underscore).

Elles peuvent être préfixées pour pouvoir identifier leur type ou leur appartenance commune à un groupe de fonctions par exemple.

Exemple :

Les constantes exploitant le style d'une fenêtre sont préfixées SW_ signifiant SHOW :

Public Const SW_MAXIMIZE = 3
Public Const SW_MINIMIZE = 6
Public Const SW_NORMAL = 1
Public Const SW_HIDE = 0

Les constantes exploitant exploitant la fonction MessageBox() MB_ signifiant MsgBox :

Public Const MB_ICONEXCLAMATION = &H30&
Public Const MB_ICONQUESTION = &H20&
Public Const MB_ICONINFORMATION = &H40&
Public Const MB_ICONSTOP = &H10&
Public Const MB_OK = &H0&
Public Const MB_OKCANCEL = &H1&
Public Const MB_YESNO = &H4&

Les variables déclarées comme paramètre dans une fonction ou dans une procédure ne sont en générale précédées d'aucun préfixe.


Exemple :

En effet, au moment de la saisie, le fait d'exploiter ou d'appeler une fonction ou une procédure provoque, par l'intermédiaire de l'IntelliSense, l'affichage du type des variables faisant office d'arguments.


Exemple :

Dim MaVar As Type

Private m_MaVar As Type

Public gvMaVar As Type

Dim strCustomerName As String

Dim strCustName As String

Dim lngProductID As Long

Dim lngProductCodeIdentifier As Long

Dim strUserLastName As Long

Dim str_user_last_name As Long

Private Function GetFullCustomerList_Sorted(ByVal Order As String, Optional ByVal TopCount As Integer = 0) As String
Dim strSQLCustomers As String
Dim strSQLOrderBy As String

  If TopCount Then
    strSQLCustomers = "SELECT TOP " & TopCount & " Gender, FirstName, LastName FROM TBLCustomers"
  Else
    strSQLCustomers = "SELECT Gender, FirstName, LastName FROM TBLCustomers"
  End If
  Select Case Order
    Case SQL_ORDER_AZ
      strSQLOrderBy = "ORDER BY LastName ASC"
    Case SQL_ORDER_ZA
      strSQLOrderBy = "ORDER BY LastName DESC"
  End Select
  strSQLCustomers = strSQLCustomer & vbCrLf & strSQLOrderBy
  GetFullCustomerList = strSQLCustomers
End Function