Voir la source de 7+1 conseils pour nommer les variables

[[Category: Portail Equipe de développement]]
[[Category: Alberto Gutierrez]]
Auteur : Alberto Gutierrez<br/>
Source : [http://www.makinggoodsoftware.com/2009/05/04/71-tips-for-naming-variables/ 7+1 tips for naming variables]<br/>
Date : 04/05/2009<br/>
----
Traducteur : Fabrice Aimetti<br/>
Date : 10/08/2009<br/>
----
Traduction :<br/>
<br/>
'''1. Le nom de la variable doit être aussi descriptif que possible. N’utilisez pas de noms génériques.'''<br/>
<br/>
Bons exemples : daysDateRange, flightNumber, carColor.<br/>
Mauvais exemples : days, dRange, temp, data, aux, ...<br/>
<br/>
Beaucoup de développeurs vont préférer donner des noms courts aux variables plutôt que des noms descriptifs pour gagner du temps lorsqu’il tape le code, mais qui s’en soucie ? Cela ne contribue pas à améliorer la qualité du logiciel, cela permet seulement de gagner quelques minutes par jour (maximum) et par développeur, alors que, lorsque les noms de variables sont descriptifs, la qualité générale du logiciel va augmenter parce que ce sera plus facile de lire et modifier le code.<br/>
<br/>
'''2. Le nom de la variable doit être aussi court que possible.'''<br/>
<br/>
Cette règle va de pair avec la première règle, les noms des variables doivent être aussi courts que possible, mais aussi descriptif que possible. Cela signifie que même si nous continuons à essayer de trouver des noms courts, nous accordons la priorité à des noms descriptifs plutôt qu’à des noms courts, et nous ne faisons que prendre le plus court quand ils sont aussi descriptifs que le plus long.<br/>
<br/>
Mauvais exemples: howLongDoesItTakeToOpenTheDoor, howBigIsTheMaterial, ...<br/>
Bons exemples: timeToOpenTheDoor, MaterialSize.<br/>
<br/>
'''3. D’accord pour utiliser des abréviations, mais expliquez l’abréviation par un commentaire.'''<br/>
<br/>
Parfois, pour avoir un nom bien descriptif, il est nécessaire de produire des noms de variables très longs, ce qui est bien, mais la taille du nom de la variable peut être améliorée en utilisant des abréviations, assurez-vous simplement que, lorsque la variable est déclarée, il y a un commentaire qui explique sa signification.<br/>
<br/>
'''4. Utilisez la notation Hongroise si nécessaire.'''<br/>
<br/>
Il y a un [http://www.joelonsoftware.com/articles/Wrong.html très bon billet de Joël] qui explique ce qu’est la notation hongroise et comment l’utiliser. Fondamentalement, il est dit que lorsque une méthode de codage que nous avons les mêmes variables d’exploitation des données, mais aussi avec différents types, la notation hongroise peut nous aider. Fondamentalement, il est dit que si dans une méthode on code avec des variables exploitant des données identiques, mais de types différents, la notation hongroise peut nous aider.<br/>
<br/>
Exemple : imaginer une méthode qui reçoit des pommes, et qui classe les pommes selon leurs couleurs, et finalement écarte celles qui ne sont pas assez mûres. Nous pouvons utiliser dans cet exemple les noms de variables suivants : incoming_apples, red_apples, yellow_apples, notMaturedYellow_apples, maturedGreen_apples, ...<br/>
<br/>
'''5. N’utilisez pas de logique négative pour vos noms de variables.'''<br/>
<br/>
Bon exemple : IsEnabled.<br/>
Mauvais exemple : IsNotEnabled.<br/>
<br/>
Il est toujours plus facile de lire et comprendre un énoncé qui est exprimé dans un langage dans la forme positive que dans sa forme négative.<br/>
<br/>
'''6. Soyez cohérent.'''<br/>
<br/>
Si vous avez utilisé un nom de variable appelé "customer" dans une méthode, alors il ne faut pas l’appeler "client" dans la méthode suivante, ou si vous utilisez une abréviation dans une méthode, utilisez-la pour toutes les autres méthodes.<br/>
<br/>
'''7. Faites correspondre la terminologie du métier de l’application avec vos noms.'''<br/>
<br/>
Dans différents domaines, différents concepts ont des sens très différents et précis, par exemple, "order" ne signifie pas toujours la même chose dans les différents domaines, essayez donc de faire correspondre ces concepts spécifiques à vos noms de variable de sorte que lorsque vous nommez quelque chose avec le nom d’un concept provenant du domaine métier de l’entreprise, cela signifie exactement la même chose.<br/>
<br/>
Exemple : Si votre client considère que "order" est juste une "commande" qui a été acceptée, n’utilisez pas "order" pour nommer dans votre code une commande non acceptée, appelez-la dans ce cas "nonApprovedOrder".<br/>
<br/>
'''Règle d’or. Investissez quelques minutes pour penser à vos noms de variables.'''<br/>
<br/>
Si vous vous retrouvez à écrire des noms de variables dès que vous en avez besoin dans votre code sans même réfléchir une seconde à leur nom, vous êtes probablement en train de choisir de mauvais noms.<br/>
Si vous essayez toujours d’avoir de bons noms de variables, et que vous y avez consacré quelques minutes pour trouver le meilleur nom, même si vous ne suivez pas les autres conseils, vous allez probablement utilisé de très bons noms de variables dans votre code.