Règles/conventions



🟨 Règles de base en Java

🔤 Sensibilité à la casse → Java distingue majuscules et minuscules. nomNomNOM.

🧱 Délimitation des blocs → Tout bloc de code (classe, méthode, boucle, condition, etc.) est entouré par accolades {}.

🔚 Fin des instructions → Chaque ligne d’instruction se termine par un point-virgule ;.

💬 Commentaires dans le code :

TypeSyntaxeUsage
Commentaire une ligne//Pour un commentaire bref
Commentaire multi-ligne/* ... */Pour expliquer un bloc de code
// Ceci est un commentaire simple

/* Ceci est
   un commentaire
   sur plusieurs lignes */

🟦 Nomenclature Java

  • ✅ Une fonction dans une classe = une méthode.
  • Elle appartient à la classe dans laquelle elle est définie.

🟩 Conventions de nommage (cours)

ÉlémentConventionExempleTechnique utilisée
ClasseMajuscule initialeAnimal, VoitureBleuePascalCase
MéthodeMinuscule initialeafficherNom()camelCase
VariableMinuscule initialenomClient, ageMoyencamelCase
ConstanteMAJUSCULE + _TAUX_DE_TAXESNAKE_CASE
Variable locale simpleLettre courtei, j (dans les boucles)

Les variables à une seule lettre sont permises uniquement pour un usage local (dans une boucle for, par exemple) par exemple i ou j. Toutes les autres variables doivent avoir un nom significatif. Les tableau doivent avoir un nom qui sous-entend la pluralité.


🟧 Indentation et lisibilité

✏️ L’indentation ne change pas le comportement du code, mais elle :

  • rend le code plus lisible,
  • montre la structure logique du programme.

📌 Règles :

  1. Indentation = tabulation (ou 4 espaces selon le style).
  2. Chaque bloc ({}) augmente le niveau d’indentation.
  3. Respecter la cohérence : ne pas mélanger tabulations et espaces.
  4. Bien aligner les blocs imbriqués : boucles, conditions, classes, etc.

Exemple :

public class Exemple {

    public static void main(String[] args) {
        int age = 18;

        if (age >= 18) {
            System.out.println("Majeur");
        } else {
            System.out.println("Mineur");
        }
    }

}

✅ Résumé

ÉlémentExempleRappel
ClasseMaClassePascalCase
MéthodeafficherProfil()camelCase
VariableageUtilisateurcamelCase
ConstanteTAUX_DE_TVAMAJUSCULES + _
Commentaire// ou /* ... */pour documenter
Bloc de code{ ... }avec indentation
Fin d’instruction;obligatoire

🟨 Conventions d’espacement en Java

Les espaces sont essentiels pour la lisibilité du code, mais doivent être utilisés de manière cohérente.


📌 1. Autour des opérateurs

✅ Toujours mettre un espace avant et après les opérateurs :

int total = a + b - c * 2;

🚫 Mauvais :

int total=a+b-c*2;

📌 2. Après les virgules

✅ Un espace après chaque virgule, pas avant :

System.out.println(nom, age, ville);

🚫 Mauvais :

System.out.println(nom,age,ville);

📌 3. Après les mots-clés (if, for, while, etc.)

✅ Mettre un espace entre le mot-clé et la parenthèse ouvrante :

if (age >= 18) {
    System.out.println("Majeur");
}

🚫 Mauvais :

if(age>=18){

📌 4. Entre les parenthèses et le contenu

Aucun espace juste après ( ou juste avant ) :

System.out.println(nom);

🚫 Mauvais :

System.out.println( nom );

📌 5. Autour des accolades { }

✅ L’accolade ouvrante est généralement placée à la fin de la ligne de déclaration, puis le bloc est indenté :

public class Exemple {
    public static void main(String[] args) {
        if (x > 0) {
            System.out.println("Positif");
        }
    }
}

🚫 Mauvais :

public class Exemple
{
    public static void main(String[] args)
    {
        if(x>0)
        {
            System.out.println("Positif");
        }
    }
}

Note : Certaines équipes préfèrent les accolades sur une ligne séparée, mais l’important est d’être cohérent dans tout le projet.


📌 6. Pas d’espace avant un point .

✅ Éviter tout espace avant ou après un point utilisé pour accéder aux membres :

utilisateur.getNom();

🚫 Mauvais :

utilisateur . getNom ();

✅ Résumé des règles d’espacement

CasBonne pratique
Opérateursa + b, x == y, etc.
Après une virgulef(x, y)
Mots-clés (if, for, etc.)if ( et non if(
Parenthèses(x + 1) et non ( x + 1 )
Accès à un membre (.)objet.methode()
Accolade ouvrante {Sur la même ligne