Suffixes
La convention de nommage Suffixes (ou nommage avec suffixes) consiste à ajouter un suffixe à un identifiant pour indiquer son type, son
rôle ou son objectif particulier. Contrairement aux préfixes (apparaissant au début de l'identifiant), les suffixes sont ajoutés à la fin du nom de la variable, de la fonction ou de
la classe. Cela permet de donner des informations supplémentaires sur la nature ou l'utilisation de l'élément tout en gardant le nom de base intact.
Exemples de suffixes courants
Voici quelques exemples de suffixes fréquemment utilisés pour différentes catégories d'éléments :
- Pour les types ou les structures de données :
Nom |
Description |
List |
Pour les collections ou les listes (exemple : nomList, utilisateurList). |
Array |
Pour les tableaux (exemple : nombresArray). |
Map |
Pour les cartes ou dictionnaires (exemple : produitsMap). |
Queue |
Pour les files d'attente (exemple : tachesQueue). |
Set |
Pour les ensembles (exemple : motsSet). |
- Pour indiquer un état ou une action :
Nom |
Description |
Handler |
Pour les méthodes ou objets qui gèrent des événements (exemple : clickHandler, errorHandler). |
Manager |
Pour les classes qui gèrent des ressources ou des processus (exemple : connectionManager). |
Controller |
Pour les classes qui contrôlent le flux d'une application ou d'une interface (exemple : userController). |
- Pour les données :
Nom |
Description |
Count |
Pour les variables qui stockent un comptage (exemple : elementCount). |
Value |
Pour les variables qui stockent des valeurs (exemple : prixValue). |
Flag |
Pour les variables booléennes (exemple : isVisibleFlag, isActiveFlag). |
Index |
Pour les variables représentant des indices (exemple : userIndex). |
- Pour les formats spécifiques ou les objets temporaires :
Nom |
Description |
Temp |
Pour des variables ou objets temporaires (exemple : tempFile, tempResult). |
Dto (Data Transfer Object) |
Pour les objets utilisés pour le transfert de données (exemple : userDto). |
Contextes d'utilisation
- Langages orientés objets comme Java, C#, ou C++
utilisent souvent des suffixes pour structurer les classes et les méthodes d'une manière claire.
- Développement d'API et de bibliothèques : Ajouter un suffixe explicite comme Handler, Manager ou Service permet de comprendre rapidement la
responsabilité d'une classe ou d'une fonction.
Avantages
- Clarté du rôle : En ajoutant un suffixe, vous pouvez immédiatement comprendre la fonction ou la nature d'un objet ou d'une variable sans avoir besoin d'examiner
son contenu. Par exemple, un Manager gère quelque chose, un Handler traite un événement.
- Cohérence : L'utilisation de suffixes standardisés dans tout un projet ou une bibliothèque assure une structure cohérente et prévisible du code.
- Maintenabilité : Lorsque vous nommez vos variables et classes en utilisant des suffixes significatifs, vous facilitez la compréhension du code pour les autres
développeurs pouvant rapidement comprendre le rôle de chaque élément.
Inconvénients
- Redondance : L'ajout de suffixes peut rendre les noms des identifiants plus longs et parfois moins élégants, surtout si plusieurs suffixes sont combinés.
- Manque de flexibilité : Si les rôles d'un objet ou d'une fonction changent, les suffixes peuvent devenir obsolètes, nécessitant des renommages dans tout le code.
Cela peut compliquer la maintenance à long terme avec des outils puissant comme Visual Studio.
Dernière mise à jour : Vendredi, le 18 mai 2024