Conventions de nommage en Java Indentation

publicité
Conventions de nommage en Java
Il existe dans la communauté de développeurs Java (et pour les autres langages aussi) des conventions
de nommage pour les variables, classes, etc. Le respect de ces conventions rend votre code plus lisible,
plus clair et aussi plus « professionnel ».
Voici les principales conventions, on pourra trouver toutes les informations sur la page
http://java.sun.com/docs/codeconv/ ou http://www.loribel.com/java/normes/nommage.html (en
français).
Donner des noms simples et descriptifs
Package :
o Tout en minuscules
o Que des lettres et des chiffres
o Ex. : com.sun.eng
Classe :
o 1ère lettre en majuscule
o Première lettre de chaque mot en majuscule, minuscules ailleurs
o Que des lettres et des chiffres
o Ex. : class MenuConvertisseur;
Variable :
o 1ère lettre en minuscule
o Mélange de minuscules et majuscules avec la première lettre de chaque mot en
majuscule
o Lettres, chiffres, signes (‘-’, ‘_’, etc. mais à éviter)
o Ex. : JMenu menuFichier;
Constante :
o Tout en majuscules
o Séparer les mots par un underscore ‘_’
o Ex. : static final int MIN_WIDTH = 4;
Indentation
De la même façon l’indentation de votre fichier java est aussi importante et rend votre code infiniment
plus lisible (pour les autres et aussi pour vous-mêmes).
Sous eclipse et NetBeans, utilisez le raccourci clavier Ctrl+Shift+F pour automatiquement
indenter correctement votre ficher.
Lorsque vous tapez du code, l’indentation de fait souvent automatiquement. Respectez-là et ne
la modifiez pas.
eclipse vous permet de définir un profil pour l’indentation très personnalisé et détaillé. Si vous
travaillez beaucoup sous eclipse, remplissez-le à votre guise. eclipse l’utilisera lorsque vous ferez
Crtl+Shift+F.
Voici la règle de base :
Tabulation après une accolade ouvrante (‘{’) et jusqu’à l’accolade fermante (‘}’)
o Bien sûr s’il n’y a pas d’accolades parce que le bloc de code ne contient qu’une
instruction, on insère tout de même une tabulation.
Ex. :
public void actionPerformed(ActionEvent e)
{
if (e.getSource() == quitter)
System.exit(0);
else if (e.getSource() == aPropos)
JOptionPane.showMessageDialog(convertisseur, "Sofia Zaidenberg",
"A Propos",JOptionPane.INFORMATION_MESSAGE);
else if (e.getSource() == configurer)
{
if (dialConfig == null)
dialConfig = new DialogConfiguration(convertisseur);
dialConfig.setVisible(true);
}
}
Téléchargement