Bonnes pratiques de nommage | Exercices corrigés

Concepts & Exercices

Nom = Clarté + Cohérence + Lisibilité

Principe fondamental

Variables

descriptif_significatif

Fonctions

action_descriptive()

Classes

NomSujet()

🏷️

Exercice 1

Identifier les conventions de nommage

Exercice 2

Corriger les noms incorrects

Exercice 3

Nommer correctement les variables

Exercice 4

Créer des noms de fonctions clairs

Exercice 5

Appliquer des conventions cohérentes

Corrigé : Exercices 1 à 3

1 Conventions de nommage

Définition :

Convention de nommage : Ensemble de règles standardisées pour nommer les éléments d'un programme (variables, fonctions, classes).

Méthode d'analyse :

Identifier le type d'élément à nommer
Appliquer la convention appropriée
Vérifier la cohérence avec le reste du code
Assurer la lisibilité et la compréhension

Convention	Langage	Exemple	Usage
snake_case	Python	nom_variable	Variables, fonctions
camelCase	JavaScript, Java	nomVariable	Variables, méthodes
PascalCase	Java, C#	NomClasse	Classes, types
SCREAMING_SNAKE_CASE	Tous	NOM_CONSTANTE	Constantes

Étape 1 : Identifier le type d'élément

Une variable se nomme différemment d'une fonction ou d'une classe

Étape 2 : Appliquer la convention

Respecter la convention du langage utilisé (ex: snake_case pour Python)

Étape 3 : Maintenir la cohérence

Utiliser la même convention pour des éléments similaires

Réponse finale :

Respect des conventions de nommage pour une meilleure lisibilité

Règles appliquées :

• Clarté : Les noms doivent être descriptifs et significatifs

• Cohérence : Utiliser la même convention dans tout le projet

• Lisibilité : Éviter les abréviations obscures

2 Correction des noms incorrects

Définition :

Nom incorrect : Nom qui ne respecte pas les conventions de nommage ou qui n'est pas descriptif.

// Avant correction
var x = 10;
function f() { return 42; }
class C { }
const PI = 3.14159;

// Après correction
var nombre_utilisateur = 10;
function obtenir_nombre_magique() { return 42; }
class CompteBancaire { }
const TAUX_TVA = 0.20;
              

Nom incorrect	Correction	Raison
x	nombre_utilisateur	Variable non descriptive
f()	obtenir_nombre_magique()	Fonction sans action claire
C	CompteBancaire	Classe non identifiable
PI	TAUX_TVA	Constante mal nommée

Étape 1 : Identifier les noms incorrects

Repérer les noms courts, ambigus ou non descriptifs

Étape 2 : Proposer des alternatives

Créer des noms descriptifs et respectant les conventions

Étape 3 : Vérifier la cohérence

S'assurer que les nouveaux noms sont cohérents avec le reste du code

Réponse finale :

Noms corrigés pour améliorer la lisibilité et la compréhension

Règles appliquées :

• Descriptif : Le nom doit refléter la fonction ou le contenu

• Longueur équilibrée : Ni trop court ni trop long

• Convention : Respecter les conventions du langage

3 Nommer correctement les variables

Définition :

Nom de variable : Identificateur qui représente une valeur dans un programme, doit être descriptif et respecter les conventions.

// Exemples de bon nommage de variables
var score_joueur = 0;
var tableau_notes = [12, 15, 18];
var est_actif = true;
var date_creation = new Date();
var taux_conversion = 0.75;

// Exemples de mauvais nommage
var s = 0;
var tab = [12, 15, 18];
var b = true;
var d = new Date();
var t = 0.75;
              

Étape 1 : Analyser le contenu

Comprendre ce que contient la variable pour lui donner un nom approprié

Étape 2 : Créer un nom descriptif

Utiliser des noms qui décrivent clairement le contenu ou l'usage

Étape 3 : Respecter les conventions

Appliquer la convention de nommage appropriée (snake_case pour Python)

Réponse finale :

Variables nommées de manière descriptive et conforme aux conventions

Règles appliquées :

• Descriptif : Le nom doit indiquer le contenu ou l'usage

• Booléens : Préfixer avec "est_", "a_", "contient_"

• Pluriel : Utiliser le pluriel pour les collections

Corrigé : Exercices 4 à 5

4 Créer des noms de fonctions clairs

Définition :

Nom de fonction : Identificateur qui représente une action dans un programme, doit exprimer clairement l'action effectuée.

// Bonnes pratiques pour les noms de fonctions
function calculer_moyenne(tableau_notes) { }
function verifier_connexion(utilisateur) { }
function sauvegarder_donnees() { }
function afficher_menu() { }
function est_valide(email) { }

// Mauvais exemples
function f(tab) { }
function verif(u) { }
function sauve() { }
function affiche() { }
function valid(e) { }
              

Type de fonction	Verbe approprié	Exemple
Calcul	calculer, obtenir, déterminer	calculer_moyenne()
Vérification	vérifier, tester, est_	est_valide()
Action	sauvegarder, afficher, envoyer	sauvegarder_donnees()
Transformation	convertir, formater, trier	trier_liste()

Étape 1 : Identifier l'action

Comprendre ce que fait la fonction pour choisir le bon verbe

Étape 2 : Choisir un verbe clair

Utiliser des verbes qui expriment clairement l'action effectuée

Étape 3 : Ajouter le contexte

Spécifier le sujet ou l'objet de l'action

Réponse finale :

Fonctions nommées pour exprimer clairement leur action

Règles appliquées :

• Action claire : Le nom doit indiquer l'action effectuée

• Verbe au début : Commencer par un verbe d'action

• Préfixe pour booléens : Utiliser "est_", "a_", "contient_"

5 Appliquer des conventions cohérentes

Définition :

Cohérence : Utilisation uniforme des conventions de nommage dans tout le projet pour faciliter la compréhension.

// Exemple de code cohérent
class GestionnaireUtilisateurs {
    constructor() {
        this.liste_utilisateurs = [];
    }
    
    ajouter_utilisateur(nom, email) {
        // Ajoute un utilisateur
    }
    
    supprimer_utilisateur(id) {
        // Supprime un utilisateur
    }
    
    obtenir_nombre_utilisateurs() {
        return this.liste_utilisateurs.length;
    }
}

// Exemple de code incohérent
class UserManager {
    constructor() {
        this.userList = [];  // camelCase
    }
    
    add_user(name, email) {  // snake_case
        // Ajoute un utilisateur
    }
    
    delete(id) {             // pas de suffixe cohérent
        // Supprime un utilisateur
    }
}
              

Étape 1 : Analyser le projet

Identifier les conventions utilisées dans le projet

Étape 2 : Maintenir la cohérence

Appliquer les mêmes conventions partout dans le code

Étape 3 : Documenter les conventions

Créer un guide de style pour le projet

Réponse finale :

Conventions de nommage appliquées de manière cohérente dans tout le projet

Règles appliquées :

• Uniformité : Utiliser les mêmes conventions partout

• Documentation : Créer un guide de style pour le projet

• Équipe : S'assurer que tous les développeurs suivent les mêmes conventions

Cours bien détaillé

Nom = Objectif + Contexte + Convention

Formule du bon nommage

🎯

Clarté : Les noms doivent être compréhensibles sans commentaire.

📏

Cohérence : Utiliser les mêmes conventions dans tout le projet.

📐

Descriptif : Les noms doivent refléter le contenu ou l'action.

📝

Convention : Respecter les conventions du langage de programmation.

💡

Conseil : Utiliser des noms complets plutôt que des abréviations obscures

🔍

Attention : Éviter les noms qui ressemblent à des mots-clés réservés

⚡

Astuce : Utiliser des préfixes pour les variables booléennes

📋

Méthode : Documenter les conventions dans un guide de style

✅

Vérification : Demander à un collègue s'il comprend le nom

Principes de nommage :

Variables : Nommer en fonction de leur contenu ou usage
Fonctions : Commencer par un verbe d'action
Classes : Utiliser des noms de sujet (nom commun)
Constantes : Majuscules avec underscore
Booléens : Préfixer avec "est_", "a_", "contient_"

Bonnes pratiques :

Éviter les noms trop courts ou ambigus
Utiliser des noms qui reflètent le but de l'élément
Respecter les conventions du langage utilisé
Maintenir la cohérence dans tout le projet
Utiliser des noms en anglais pour la portabilité

Variables

snake_case

Fonctions

snake_case

Classes

PascalCase

Bonnes pratiques de nommageExercices corrigés

Bonnes pratiques de nommage
Exercices corrigés