Bienvenue à Blogs CodeS-SourceS Identification | Inscription | Aide

CoqBlog

.NET is good :-)
{ Blog de coq }

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

- Merci par Blog de Jérémy Jeanson le 10-01-2019, 20:47

- Office 365: Script PowerShell pour auditer l’usage des Office Groups de votre tenant par Blog Technique de Romelard Fabrice le 04-26-2019, 11:02

- Office 365: Script PowerShell pour auditer l’usage de Microsoft Teams de votre tenant par Blog Technique de Romelard Fabrice le 04-26-2019, 10:39

- Office 365: Script PowerShell pour auditer l’usage de OneDrive for Business de votre tenant par Blog Technique de Romelard Fabrice le 04-25-2019, 15:13

- Office 365: Script PowerShell pour auditer l’usage de SharePoint Online de votre tenant par Blog Technique de Romelard Fabrice le 02-27-2019, 13:39

- Office 365: Script PowerShell pour auditer l’usage d’Exchange Online de votre tenant par Blog Technique de Romelard Fabrice le 02-25-2019, 15:07

- Office 365: Script PowerShell pour auditer le contenu de son Office 365 Stream Portal par Blog Technique de Romelard Fabrice le 02-21-2019, 17:56

- Office 365: Script PowerShell pour auditer le contenu de son Office 365 Video Portal par Blog Technique de Romelard Fabrice le 02-18-2019, 18:56

- Office 365: Script PowerShell pour extraire les Audit Log basés sur des filtres fournis par Blog Technique de Romelard Fabrice le 01-28-2019, 16:13

- SharePoint Online: Script PowerShell pour désactiver l’Option IRM des sites SPO non autorisés par Blog Technique de Romelard Fabrice le 12-14-2018, 13:01