Conventions de nommage

Règles de nommage

Les règles suivantes définissent le standard général de nommage des différents éléments du code :

• Utilser des noms en entier pour décrire précisément une variable, un membre, une classe, une méthode, etc. Par exemple, utiliser des noms tels que birthDate, length, firstName, getWidth, etc. Bien que les noms tels que x1, y1 ou fn soient faciles à écrire, car ils sont courts, ne fournissent pas d'indication sur ce qu'il représentent et peuvent donc provoquer des erreurs d'interprétation.
• Utiliser la terminologie du domaine d'application. Si l'utilisateur parle de ses clients en utilisant le terme de patient, il faudra utiliser le terme Patient pour le nom de la classe et non Client.
• Utiliser une notation qui mélange la casse pour que les noms soient plus lisibles. Les minuscules doivent être utilisées en général. Cependant, la première lettre des noms de classes et des interfaces doiet être en majuscule.
• Utiliser les abréviations parcimonieusement et intelligemment. Cela signifie qu'une liste de noms abrégés standards doit être maintenue.
• Éviter les noms trop longs. Les noms de moins de 15 lettres peuvent suffire la plupart du temps. Par exemple le nom de classe ProductOrPhysicalServiceOrVirtual peut simplement être remplacé par Offer.
• Éviter de mettre des caractères accentués. Afin de simplifier l'écriture du code à certaines populations de développeurs qui ne possèdent pas de clavier avec caractères diacritiques, il est souhaitable de ne pas utiliser de caractère accentués. Malheureusement, il se peut que la lisibilité devienne difficile.
• Éviter les noms qui sont similaires ou qui ne diffèrent que par leur casse. Par exemple, les noms de variables dateJour et dataJour, ne devraient pas être utilisés ensemble.
• Mettre en majuscule la première lettre des acronymes et sigles standards. Les noms contiendront souvent des acronymes standards. Les noms comme cffCollaborateur pour un attribut ou CffException pour une classe sont plus facile à lire que cFFCollaborateur et CFFException.