Discussion :

[Hinault Romaric]

Quels sont les pires noms de variables que vous avez déjà vus ?
Un développeur identifie les deux plus mauvais noms de variables couramment utilisés dans le code


Un problème auquel est continuellement confronté le développeur dans son activité est l’attribution des noms aux variables.

Afin de faciliter la lisibilité et la compréhension du code, le programmeur opte le plus souvent pour des variables suffisamment descriptives ou se reporte à des conventions de nommage.

ANDY Lester, un développeur senior se penche dans un billet de blog sur les noms attribués aux variables et présente selon lui les deux pires noms qui sont constamment utilisés par les développeurs pour qualifier les variables.

La pire dénomination qu’un développeur peut donner à une variable est selon Lester le nom « data ».

Code php :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
 
$data = read_record();
print "ID = ", $data["CUSTOMER_ID"];

« Bien sûr il y a des données ! C’est ce que contiennent les variables » écrit Lester, qui ironise par la suite. « C’est comme si vous emballez vos biens dans des cartons de déménagement et vous les étiquetez le carton des matières ».

Pour ANDY Lester, les noms des variables doivent dire quel type de données est manipulé.

En seconde position, l’utilisation des chiffres pour distinguer les variables. Exemple : data2.

Code php :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
 
$total = $price * $qty;
$total2 = $total - $discount;
$total2 += $total2 * $taxrate;
 
$total3 = $purchase_order_value + $available_credit;
if ( $total2 < $total3 ) {
    print "You can't afford this order.";
}

N’importe quelle variable qui s’appuie sur un chiffre pour se distinguer d’une autre doit être immédiatement renommée. Le véritable assassin dans le code ci-dessus selon Lester est la ligne « if ($ total2 <$ total3) » qui obliger à remonter plus haut pour l’interpréter.

Ce ne sont là que deux exemples sur de mauvais noms de variables qui sont utilisés par les développeurs.



Source : Blog ANDY Lester


Et vous ?

Avez-vous déjà utilisé ces noms pour vos variables ?

Quels autres pires noms de variables avez-vous déjà vus ?

[elmcherqui]

On a tous nommé nos variables quand on a debuté le dev jusqu'a ce qu'on comprenne que ce n'etait pas comme les maths ( a , b , c , x ... ) et pour vraiment comprendre les degats de ce genre de nomoclature je conseil

http://www.pearson.fr/livre/?GCOI=27440100643800

version francaise de clean code

Une Perle , et je vous assure qu'apres avoir lu le livre votre vision des variable aura changé

[Zack_r]

Pour ma part, un ancien développeur nommer toutes ces variables en mettant toto...

Par exemple tabtotot, toto, toto1, toto4...

L'angoisse quand j'ai vue le code la première fois...

J'espère une chose, c'est qu'il a complètement changé d'orientation professionnelle. Je sais je suis méchant, mais à cause de lui j'ai connu l'enfer !

[webpsi]

Il n'y a pas trop longtemps, j'ai vu dans un projet open source (TUIOdroid), énormément de variables d'une seule lettre, c'est vraiment une horreur quand on rencontre une variable qui s'appelle : c, d, a ...

Un petit extrait :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
cw = getWidth();
ch = getHeight();

bx = cw/2 - backgroundImage.getWidth()/2;
by = ch/2 - backgroundImage.getHeight()/2;

Canvas c = getHolder().lockCanvas();
                
if (c != null) {
     c.drawColor(Color.WHITE);
     c.drawBitmap(backgroundImage,bx,by,null);

C'était le 1er travail que j'ai eu pour mon 1er emploi, ça m'a vraiment fait peur pour la suite, mais je suis jamais retomber sur un autre cas extrême comme celui là.

[vampirella]

Les variables de quelques lettres (voire une seule) me rappelle surtout de la décompilation ...
Ceci dit, si quelqu'un est capable de coder en nommant tel que décrit par "webpsi", c'est que la personne a loupé des cours de programmation

Pour revenir sur la première critique de Lester, il arrive que je nomme une variable "data" lorsque par exemple je ne connais pas d'avance ce que je trouverais dans cette case ... en l'occurrence, lorsque je lisais des cases d'Excel. Je ne sais pas si c'est forcément justifié, mais je n'avais pas trouvé comment nommer mieux cette variable qui récupérait directement la valeur de la case.

[djinneo]

Pour les boucles, l'emploi d'itérateurs nommés avec une seule lettre (au hasard "i", "j", "k") relève quasi de la convention d'écriture.

Je m'étais donc fait "plaisir" en les bapisant "irene", "julie" et "katia" -ce qui était en même temps, un clin d'oeil à des stagiaires de la boîte.

Mais j'ai trouvé ça bcp moins fun quand ma hiérarchie a inspecté mon code

[barbouille]

Pour les boucles, l'emploi d'itérateurs nommés avec une seule lettre (au hasard "i", "j", "k") relève quasi de la convention d'écriture.

Je m'étais donc fait "plaisir" en les bapisant "irene", "julie" et "katia" -ce qui était en même temps, un clin d'oeil à des stagiaires de la boîte.

Mais j'ai trouvé ça bcp moins fun quand ma hiérarchie a inspecté mon code

Boudiou c'était donc toi !!

En ce qui me concerne, le pire a été pendant une mission "an 2000" pour certifier un programme cobol (qui a dit "le vieux") dont tous les noms de variables et de paragraphes étaient des prénoms de filles.

Ben pour trouver que Justine et Agathe étaient des dates, mais pas Christine ni Gisèle ça ne fut point simple du tout.

[atha2]

Il n'y a pas trop longtemps, j'ai vu dans un projet open source (TUIOdroid), énormément de variables d'une seule lettre, c'est vraiment une horreur quand on rencontre une variable qui s'appelle : c, d, a ...

Un petit extrait :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
cw = getWidth();
ch = getHeight();

bx = cw/2 - backgroundImage.getWidth()/2;
by = ch/2 - backgroundImage.getHeight()/2;

Canvas c = getHolder().lockCanvas();
                
if (c != null) {
     c.drawColor(Color.WHITE);
     c.drawBitmap(backgroundImage,bx,by,null);

C'était le 1er travail que j'ai eu pour mon 1er emploi, ça m'a vraiment fait peur pour la suite, mais je suis jamais retomber sur un autre cas extrême comme celui là.

Ok le nom des variables est court (dans ton exemple) mais c'est pas trop compliqué de comprendre que x et y font référence à des coordonnées, que w et h sont la dimension, que c correspond au canvas et que b correspond au backgroundImage. Après si le code fait 300 lignes je veux bien croire que ça deviennent compliqué mais si la variable est utilisé au maximum 20 ligne après sa déclaration ça devrait aller.
De la à appeler ça un cas extrême, ça voit que tu n'est pas tombé sur du code en notation hongroise (genre arpszTableau pour un tableau de pointeurs de chaînes de caractères) qui a peut-être un intérêt dans les langages au typage implicite mais en Java ??

En seconde position, l’utilisation des chiffres pour distinguer les variables. Exemple : data2.


Code php :
Sélectionner tout - Visualiser dans une fenêtre à part
1
2
3
4
5
6
7
8
9

$total = $price * $qty; $total2 = $total - $discount; $total2 += $total2 * $taxrate; $total3 = $purchase_order_value + $available_credit; if ( $total2 < $total3 ) { print "You can't afford this order."; }


N’importe quelle variable qui s’appuie sur un chiffre pour se distinguer d’une autre doit être immédiatement renommée. Le véritable assassin dans le code ci-dessus selon Lester est la ligne « if ($ total2 <$ total3) » qui obliger à remonter plus haut pour l’interpréter.

Ce ne sont la que deux exemples sur de mauvais noms de variables qui sont utilisés par les développeurs.

Je ne suis pas sur de comprendre le problème (mais je ne suis pas un expert PHP). Ici le problème est lié au faite que l’interpréteur va mettre plus de temps à déterminer de quelle variable on parle ? Dans ce cas là, je pense que le problème vient plus de l'interpréteur que du développeur. Quand à l'utilisation de variable au nom sans réelle sémantique comme total1 et/ou total2, il arrive que certain résultat intermédiaire de calcul n'ai pas vraiment sens. Auquel cas appeler une variable "dd" (ou toto) ne me gène absolument pas.

Dans l'ensemble j'avoue que j'ai tendance à utiliser de nom de variable à rallonge du type trucQuiFaitMachineDansTelContext c'est long mais au moins on comprend à quoi elle sert et avec les IDE, la longueur de la variable n'importe plus vraiment.

[webpsi]

Dans le projet que j'ai cité au dessus, il y avais 2 problème : le même que le "problème data" de l'article, ex : h c'est la hauteur, mais de quoi ???, il faut donc remonter le code jusqu'à trouver ce que l'on veux.

L'autre problème est que l'on ne sait pas l'utilité de la variable, le canvas à été utiliser pour afficher du texte informatif sur une image, comment on sait que "c" est censé afficher si le serveur est en ligne et notre adresse IP ?!?

C'était surtout utilisé dans des fonctions, ce qui peut énormément géner quand on utilise une fonction et que l'on voit 2 lettres comme argument, on est obliger de lire le contenu de la fonction pour savoir quoi mettre.

Même si je sais qu'il y a pire, je n'appelle pas ça un code fait par un informaticien (ce qui n'est peut être pas le cas pour ce projet).

PS : dans ce projet j'ai aussi vu du copier-coller de fonctions statiques

[nu_tango]

Concrètement, dès que l'on commence à avoir moultes variables (fonctions mathématiques, physiques, etc.) on se retrouve avec des choses telles que (par exemple) :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
 int mandel(double px, double py) {
    double zx = 0.0, zy = 0.0;
    double zx2 = 0.0, zy2 = 0.0;
    int value = 0;
    while (value < MAX && zx2 + zy2 < 4.0) {
      zy = 2.0 * zx * zy + py;
      zx = zx2 - zy2 + px;
      zx2 = zx * zx;
      zy2 = zy * zy;
      value++;
    }
    return value;
  }

Qui n'est vous en conviendrez, succint mais pas des plus lisible.
Pour ce qui est de la lisibilité, des "vrais exemples de best practices" sont introduit dans l'ouvrage de Robert C. Martin cité précédement par elmcherqui : Clean Coding (Coder Proprement) que je recommande vivement à tout développeur (les exemples sont malheureusement seulement en java...) un tant soit peu consciencieux.

Pour les boucles, l'emploi d'itérateurs nommés avec une seule lettre (au hasard "i", "j", "k") relève quasi de la convention d'écriture.

Oui mais il ya du pour et du contre dans le leur utilisation tel que. D'aucuns disent qu'une syntaxe telle que celle ci-dessous :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
	for (int fruitNumber = 0; fruitNumber < fruits.size(); fruitNumber++) {
			if (fruits.get(fruitNumber).isBanana()) {
				// What to do with bananas
			}
		}

bien que plus verbeuse est à préférer à quelquechose de ce style :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
for (int i=0;i < f.size(); i++) {
			if (f.get(i).isB()) {
				// What to do with bananas
			}
		}

[Freem]

Je n'ai pas d'autocomplétion (Python + Vim), et ça ne m'empêche pas d'utiliser parfois des noms qui font plus de dix, voire quinze caractères.

Hum... CTRL+N sur vim pour auto-compléter un nom de symbol local. Sinon je crois qu'il y a un autre artifice, avec les ctags. Bon , je peux me planter, je suis pas expert vim, mais ça marche en c++.

Concrètement, dès que l'on commence à avoir moultes variables (fonctions mathématiques, physiques, etc.) on se retrouve avec des choses telles que (par exemple) :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
 int mandel(double px, double py) {
    double zx = 0.0, zy = 0.0;
    double zx2 = 0.0, zy2 = 0.0;
    int value = 0;
    while (value < MAX && zx2 + zy2 < 4.0) {
      zy = 2.0 * zx * zy + py;
      zx = zx2 - zy2 + px;
      zx2 = zx * zx;
      zy2 = zy * zy;
      value++;
    }
    return value;
  }

Qui n'est vous en conviendrez, succint mais pas des plus lisible.
Pour ce qui est de la lisibilité, des "vrais exemples de best practices" sont introduit dans l'ouvrage de Robert C. Martin cité précédement par elmcherqui : Clean Coding (Coder Proprement) que je recommande vivement à tout développeur (les exemples sont malheureusement seulement en java...) un tant soit peu consciencieux.



Oui mais il ya du pour et du contre dans le leur utilisation tel que. D'aucuns disent qu'une syntaxe telle que celle ci-dessous :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
	for (int fruitNumber = 0; fruitNumber < fruits.size(); fruitNumber++) {
			if (fruits.get(fruitNumber).isBanana()) {
				// What to do with bananas
			}
		}

bien que plus verbeuse est à préférer à quelquechose de ce style :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
for (int i=0;i < f.size(); i++) {
			if (f.get(i).isB()) {
				// What to do with bananas
			}
		}

Dans ton cas, il aurait suffit que "f" ait été nommé "fruits" pour que le code soit lisible. Et même plus que le 1er.
D'ailleurs, je ne sais pas de quel langage tu parles, mais pour java il y a des for_each, et pour c++, des algo qui font la même chose (le for_each d'avant C++11 est immonde imho, et je ne considère donc que le C++03 ici).

D'ailleurs, en C++ ça aurait plus donné ceci dans ma convention perso:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
typedef FruitIter vector<Fruit>::iterator ;
for (FruitIter it=fruit.begin();it < fruit.end(); ++it)
{
  if(it->isBanana())
  {
      // What to do with bananas
  }
}

Bon, sans find_if, évidemment. Mais la on a juste la variable de boucle qui n'a pas de vrai nom, et pourtant, je pense que ça reste très lisible. Peut-être même plus que ton 1er exemple (j'imagine que ça peut dépendre des gens)

Et en 2011 (qui ne fait que rattraper d'autres langages), ça aurait fait ceci:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
for(auto &i: fruit)
{
  if(i.isBanana())
  {
    //...
  }
}

La, je trouve que ça ne souffre plus la comparaison. D'autant que le i est communément utilisé.

[djinneo]

fonctions mathématiques

j'ai lu hier:
si "z" est le rayon d'une pizza et "a" son épaisseur, alors son volume est donné par: Pi*z*z*a

[jv-boy]

Avez-vous déjà utilisé ces noms pour vos variables ?

Ouais quand j'etais debutant, en bts alternance. Je vais debugger du code VBA et ajouter des fonctionnalites. Comme je voyait des variables genre total1, total 2 ben j'enchainais avec total3 etc ...

A l'epoque je croyais que c'etait un truc bien, etant donnee que mon maitre de stage le faisait !

Quels autres pires noms de variables avez-vous déjà vus ?

D'apres mes souvenirs, toujours dans cette boite:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
int test;
int a;
int b;
int c;
...
int v;

int romain = 0;
String chaine;

[rOnnie974]

Dans le genre pas mal, les mecs qui codent en français:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
function ChangeMagasinDirectement_chargee(response) {
        var maDonnee = JSON.parse(response.d);
        fermerPopupConfirmationChangementMagasin();
        document.location.href = maDonnee.monUrlAChanger;
    }
    
    //Pour afficher les services disponibles dans la commune
    function ObtenirInformationsServicesCommune_chargee(response) {
        var maDonnee = JSON.parse(response.d);
        
        (maDonnee.nbPointsRetrait > 0) ? $(".prRetraitDispoCommune").show() : $(".prRetraitDispoCommune").hide();
        (maDonnee.nbLivraison > 0) ? $(".livDispoCommune").show() : $(".livDispoCommune").hide();
        (maDonnee.nbDrive > 0) ?  $(".driveDispoCommune").show() :  $(".driveDispoCommune").hide();
        (maDonnee.nbRetrait > 0) ? $(".RetraitDispoCommune").show() : $(".RetraitDispoCommune").hide();
    }

http://www.expressmarche.com

[air-dex]

Je rejoins ce qui disent que les pires sont les variables d'un seul caractère. J'ai même parfois vu des choses du type:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
int a;//age du capitaine

Mais Bo*$€|_ ! Pourquoi ne pas avoir écrit:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
int age_du_capitaine;

Pour les noms de variables assez courts, est-ce que cela ne remonte pas à une époque où les développeurs n'avaient pas d'autocomplétion et où ces derniers avaient autre chose à faire que de finir d'écrire des noms de variables à rallonge ? Tout le monde n'a pas toujours eu un Ctrl+Espace pour finir de taper un nom d'une variable.

Dans le genre pas mal, les mecs qui codent en français:

Pas forcément d'accord. "Coder systématiquement en anglais parce que c'est comme ça" n'est pas forcément une bonne pratique. À mon avis le choix de la "langue de développement" dépend aussi de celles des développeurs derrière leur code. Est-ce un crime que de coder en français un programme dont on sait pertinemment qu'il ne sera jamais regardé par des personnes non francophones (comme un programme fait par et pour soi-même par exemple) ? Je ne le pense pas, bien au contraire.

Pour moi la langue d'un programme devrait être avant tout la langue (maternelle) des développeurs qui ont affaire au code. Et ils ne sont pas toujours tous forcément anglais.

[ProgVal]

Pour les noms de variables assez courts, est-ce que cela ne remonte pas à une époque où les développeurs n'avaient pas d'autocomplétion et où ces derniers avaient autre chose à faire que de finir d'écrire des noms de variables à rallonge ? Tout le monde n'a pas toujours eu un Ctrl+Espace pour finir de taper un nom d'une variable.

Je n'ai pas d'autocomplétion (Python + Vim), et ça ne m'empêche pas d'utiliser parfois des noms qui font plus de dix, voire quinze caractères.

[LooserBoy]

Pas forcément d'accord. "Coder systématiquement en anglais parce que c'est comme ça" n'est pas forcément une bonne pratique. À mon avis le choix de la "langue de développement" dépend aussi de celles des développeurs derrière leur code. Est-ce un crime que de coder en français un programme dont on sait pertinemment qu'il ne sera jamais regardé par des personnes non francophones (comme un programme fait par et pour soi-même par exemple) ? Je ne le pense pas, bien au contraire.

Pour moi la langue d'un programme devrait être avant tout la langue (maternelle) des développeurs qui ont affaire au code. Et ils ne sont pas toujours tous forcément anglais.

Je dois être bizarre car même à titre personnel, dans un passé pas si lointain (j'ai arrêté, ma psychothérapie a fonctionné ), je codais en anglais. C'est probablement par la force des habitudes ou le fait que l'anglais soit ma deuxième langue, après le français, apprise très jeune et qui, par conséquent, ne me pose strictement aucun problème.

[Thorna]

Vaste débat, si j'en crois le nombre de pages par jour... Et qui, comme la plupart des vastes débats du domaine informatique (et de tout autre domaine d'ailleurs) fait ressortir un certain nombre de règles ou de pratiques conseillées et pas toujours respectées, et aussi beaucoup de "clochers" qui défendent leur religion becs-et-ongles.
Ce qui me parait souhaitable, c'est que le code soit lisible. Pas uniquement par celui qui l'écrit, mais aussi par ceux qui corrigeront ensuite. Pas du tout par le client, à moins qu'il entre dans une des 2 catégories. Et "lisible", ça ne veut pas dire la même chose pour tout le monde :

• avec des noms de variable (peut-être longs) significatifs ? Du genre "maCommande", "nombreClients", etc.
• avec des noms de variables "classiques" ? Du genre i, j, k dans les boucles.
• avec des noms de variables "surchargés" par tout un tas de préfixes de types, de genre etc.
• avec des noms de variables dans la langue des lecteurs.
• etc.

"Coder systématiquement en anglais parce que c'est comme ça" n'est pas forcément une bonne pratique. [...] Pour moi la langue d'un programme devrait être avant tout la langue (maternelle) des développeurs qui ont affaire au code. Et ils ne sont pas toujours tous forcément anglais.

+1

J'ai travaillé avec un collègue qui accentuait les nom de variable. Que du bonheur!!!

Et... ? L'UTF8, c'est pas que pour faire de l'ASCII-7bits !

[GrandFather]

Et... ? L'UTF8, c'est pas que pour faire de l'ASCII-7bits !

...et avec les langages dynamiques ne nécessitant pas de déclaration des variables avant leur initialisation, utiliser par erreur « facturé » à un endroit du code et « facture » à un autre pour désigner la même variable est facile et est la garantie d'une joyeuse séance de débogage.

A l'œil il est plus facile de repérer une erreur typographique comme l'oubli ou l'ajout d'une lettre qu'une erreur d'accent.

[deuz59]

Sous un autre point de vue, des noms de variables pourris, confusant, c'est bon pour la sécurité => plus besoin d'obfusquer le code s'il est déjà illisible par ses propres développeurs