Bienvenue à Blogs CodeS-SourceS Identification | Inscription | Aide

CoqBlog

.NET is good :-)
{ Blog de Gaël Covain }

Actualités

Nommez vos variables de la même manière que votre premier-né

"You should name a variable using the same care with which you name a first-born child."
- James O. Coplien, Denmark   (foreword to Clean Code)

Je suis tombé sur cette citation via ce post : Name a variable like you name your first-born

C'est sans doute volontairement exagéré, mais justement ça souligne bien l'importance de nommer correctement une variable, ce qui n'est pas forcément une tâche aisée.
Il faut réussir à exprimer avec quelques mots la raison d'exister de la variable, tout en restant le plus concis possible afin de ne pas atteindre des longueurs trop importantes.

Au moment de la frappe initiale du code, utiliser une variable "i", "x", "y", "instance" (...) peut paraitre anodin, mais souvenez vous de la dernière fois que vous avez maintenu du code utilisant ce type de nommage...

Nommez vos variables en pensant que celui qui maintiendra votre code est un psychopathe qui connait votre adresse.

Ce post vous a plu ? Ajoutez le dans vos favoris pour ne pas perdre de temps à le retrouver le jour où vous en aurez besoin :
Posted: samedi 28 novembre 2009 12:38 par coq
Classé sous : , , ,

Commentaires

Amethyste a dit :

je ne peux qu'approuver.

Mais je voudrai aussi ajouter qu'il est important de garder une cohérence dans tout le code. Un même paramètre ne doit pas changer de nom lorsqu'il voyage d'une méthode à l'autre par exemple.

# novembre 28, 2009 18:30

coq a dit :

Effectivement, bonne remarque, merci !

Je vais d'ailleurs en profiter, comme c'est lié, pour ajouter qu'il vaut mieux éviter autant que possible d'inverser la signification d'un booléen entre 2 méthodes.

Ex :

"void DoSomething(Boolean useIt){...}"

et

"void DoSomethingInternal(Boolean dontUseIt){...}"

void DoSomething(Boolean useIt)

{

 ...

 this.DoSomethingInternal(!useIt);

 ...

}

Ce bon vieux "!" sais toujours se faire oublier au mauvais moment, et se cache bien au debug...

# novembre 28, 2009 19:13
Les commentaires anonymes sont désactivés

Les 10 derniers blogs postés

- Quelques trucs intéressants (05/09/2010) par CoqBlog le il y a 17 heures et 12 minutes

- EnumerableCollection par Matthieu MEZIL le 09-03-2010, 23:23

- [HS] Chrome 6 + Moi = Coup de gueule ! par Blog de Jérémy Jeanson le 09-03-2010, 12:12

- [WP7] Utiliser un WrapPanel dans une application Windows Phone 7 par Blog Technique d'Audrey PETIT le 09-01-2010, 22:40

- [WP7] Besoin d’avoir des données en cache par Nicolas Humann le 09-01-2010, 15:12

- [TFS] Comment forcer la saisie d’un Area ou Iteration par Atteint de JavaScriptite Aiguë [Cyril Durand] le 09-01-2010, 02:01

- SQL : Fonctions d'agrégation MIN/MAX et valeurs NULL par CoqBlog le 09-01-2010, 00:04

- Votez pour Warnygo par Nicolas Humann le 08-31-2010, 11:58

- [SharePoint 2010] L'administration toolkit V1 est disponible par Julien Chable le 08-31-2010, 01:42

- Développement Windows Mobile 6.x : Gestion des Forms & Machines d'états par Le Blog de Pi-R (Pierre Cambier) le 08-30-2010, 13:20