Choix des identificateurs

Le premier choix est celui de la langue à utiliser pour les identificateurs. Dans l'industrie d'aujourd'hui, les équipes de développement sont souvent réparties dans plusieurs pays. Dans ce cas, il est plus prudent de toujours utiliser l'anglais pour les identificateurs. Même un projet franco-français peut devenir un projet international plus tard.

De façon générale, un identificateur significatif, comme number-of-boats est plus facile à lire qu'un identificateur peu significatif comme numbts. L'argument qui consiste à dire que les identificateurs longs nécessitent davantage de temps de frappe n'est pas valable. Emacs propose deux fonctionnalités pour éviter la frappe de ces identificateurs : abbrev-mode et dabbrev-expand permettant respectivement de définir des abréviations et de compléter un mot à partir d'un préfixe.

Dans un identificateur construit à partir de plusieurs mots, ces mots doivent être séparés par un caractère `-' et non par un caractère `_'.

Un identificateur significatif n'est pas forcément long. D'abord, chaque domaine d'application a ses abréviations et son jargon. Le choix des identificateurs est destiné à faciliter la lecture du code pour le programmeur qui va maintenir l'application et ce programmeur connaît forcément le domaine d'application.

Certains identificateurs ont une signification très précise. Les identificateurs i, j et k sont souvent des compteurs de boucle, alors que x, y et z sont utilisés pour des arguments dont la signification est sans importance. Cet exemple est très idiomatique :

(defun add-elements (x y)
  (do ((i 0 (1+ i)))
      (...)
    ...))

alors que celui-ci ne l'est pas :

(defun add-elements (the-first-element the-second-element)
  (do ((loop-var-1 0 (1+ loop-var-1)))
      (...)
    ...))

Un identificateur dont le contenu est un objet d'un type (abstrait) particulier, porte souvent le nom de ce type :

(defun account-balance (account)
  ...)

Une variable dont le contenu est une liste ou un vecteur d'objets d'un type (abstrait) particulier, porte souvent le nom de ce type au pluriel :

(defun update-accounts (accounts)
  ...)

On ne met jamais le suffixe list ou vector. Ne jamais écrire :

(defun update-accounts (account-list)
  ...)