1 - par Jacques LAFORGUE

Règle de codage pour les TP de Java - 1 - J. LAFORGUE
16/04/17
- 1 -
I
I. . F FI IC CH HI IE ER RS S E ET T R RE EP PE ER RT TO OI IR RE ES S
I.1. Suffixes
Le suffixe qui suit le nom d’un fichier indique explicitement le type des informations qu’il contient .
On utilise les suffixes suivant :
Suffixe
Type du fichier
.java
.class
.txt
.dat
.jar
.sh
fichier source Java
fichier objet Java
fichier de données textuel
fichier de données binaires
fichier d'archive java
scripts shells
Les répertoires n'ont jamais de suffixe.
I.2. Noms des répertoires
Les répertoires s'écrivent tous en minuscules.
Exemples : projet1, projet2
packages
data
L'usage du "under-score" doit rester exceptionnel.
Exemples: packages_v1
data_old
projet1_prof
projet1_correction
I.3. Noms des fichiers
Une majuscule à chaque mot, pas de "under-score", le reste en minuscule
Exemple: StringTokenizer.java
CatalogueOd.java
CatalogueOdInterface.java
Toto.txt
Test1.txt
Les noms des fichiers contenant les sources Java doivent impérativement avoir le même que la classe publique
qu’ils contiennent.
I
II I. . I ID DE EN NT TI IF FI IC CA AT TE EU UR RS S

Règle de codage pour les TP de Java - 2 - J. LAFORGUE
16/04/17
- 2 -
En règle générale, les identificateurs doivent avoir des noms explicites. La seule exception autorisée à cette règle
est d'utiliser des variables muettes i, j, k, ... pour les indices de tableaux et les répétitions dont on connaît à
l'avance le nombre d'itérations.
II.1. Identificateur de classe et d’interface
Un identificateur de classe et d’interface s'écrit en minuscules et commence par une majuscule. Si
l'identificateur est composé de plusieurs mots, chaque mot commence par une majuscule.
class Date {…}
II.2. Identificateur de variable, d’attribut, de paquetage ou de méthode (autre
que le constructeur)
Un identificateur de variable, d’attribut, de paquetage ou de méthode s'écrit en minuscules. Si
l'identificateur est composé de plusieurs mots, chaque mot autre que le premier commence par une
majuscule. Un identificateur de méthode Java se comportant comme une procédure algorithmique est un
verbe à l'infinitif (action). Un identificateur de méthode Java se comportant comme une fonction
algorithmique est un nom ou un adjectif (expression).
Afin de discerner les variables des attributs de la classe, nous
préfixons TOUJOURS les variables locales par 'l_' et les arguments
des méthodes par 'a_'
{
float l_Moyenne ;
Date l_DateDuJour ;
.....
.....
}
int chercherMaximum () ;
boolean estVide (Liste a_Liste) ;
package morpion ;
Les attributs d'une classe ne sont pas préfixés par 'l_' ou 'a_' ou
'_':
private String nom;
private String prenom;
Les attributs doivent être toujours privés. Sauf dans le cas des attributs d'une classe privée à un
fichier.java.
II.3. Identificateur de constructeur
Un identificateur de constructeur s'écrit de la même manière que l’identificateur de la classe auquel il se
rapporte.

Règle de codage pour les TP de Java - 3 - J. LAFORGUE
16/04/17
- 3 -
II.4. Identificateur de constante
Un identificateur de constante s'écrit en majuscules. Si l'identificateur est composé de plusieurs mots,
chaque mot est séparé du suivant par le symbole souligné.
static final int MAX = 100 ;
static final int LG_MAX = 10 ;
static final int NB_ELEVES = 50 ;
I
II II I. . D DE EC CL LA AR RA AT TI IO ON N D DE ES S V VA AR RI IA AB BL LE ES S
On peut déclarer les variables n'importe où dans le code, mais il est toujours préférable de les déclarer tous en
début de méthode.
I
IV V. . C CO OM MM ME EN NT TA AI IR RE ES S
On distingue sept types de commentaires : le commentaire d'en-tête de fichier, le
commentaire d'en-tête de classe, le commentaire d’introduction d’une partie de
méthode ou de fichier ou de classe, le commentaire d'en-tête d'une méthode, le
commentaire de déclaration de variables, le commentaire de déclaration d’attributs et le
commentaire de trace d'affinage.
IV.1. En-tête de fichier
Mettre en début de tous les fichiers sources, les lignes indiquant le groupe de Tp et le nom du fichier.
// cnamp<N>
// <Nom du fichier>.<suffixe>
Exemple:
// cnamp10
// Individu.java
IV.2. En-tête de la classe
Un programme est précédé d'un cartouche de commentaire conforme à la norme javadoc fournissant
différentes informations concernant le rôle du programme, le nom du fichier source précédé de son
chemin d’accès, le langage utilisé, le nom de l’utilisateur et des auteurs, le numéro de version et la date

Règle de codage pour les TP de Java - 4 - J. LAFORGUE
16/04/17
- 4 -
de création ce celle-ci ainsi que les références aux classes utilisées.
/**
*
* ROLE DU PROGRAMME : jouer au morpion contre la machine
* FICHIER SOURCE :
usr/public/mesProgrammes/jouerAuMorpion.C
* LANGAGE : Java
* BINOME : 1a01algo
*@author Emile TOTO & Josiane TITI
*@version 0.0.1 10/10/1999,
*@see java.util.Vector
*@see morpion.Case
*/
IV.3. Titre de début d’une partie de fichier, de classe ou d’interface
Chaque partie de fichier, de classe ou d’interface (importation des paquetages, déclaration des
constantes, déclaration des attributs et définition des méthodes) est introduite par un titre.
//-------------------------------------------------------------
--
// IMPORTATION DES PAQUETAGES UTILISES
//-------------------------------------------------------------
--
…
//-------------------------------------------------------------
--
// DECLARATION DES CONSTANTES
//-------------------------------------------------------------
--
…
IV.4. En-tête de méthode
L'en-tête d’une méthode est précédé d'un cartouche, respectant la norme javadoc, explicitant le plus
exactement possible le rôle de la méthode. Ce cartouche mentionne systématiquement les paramètres
formels de la méthode, ainsi que le résultat retourné s'il en existe un. Signaler aussi les exceptions
levées par la méthode.
/**
* recherche la position de la première occurrence de
* l'élément x dans la tranche de tableau tab [1..n]
*@param a_n borne supérieure de la tranche
*@param a_x élément recherché
*@return le rang désignant la place de l’élément dans le
* tableau s’il existe –1 sinon
*@exception hors_borne si n est inférieur à 0 ou s’il est
* supérieur à la taille du tableau
*/
int rechercherOccurrence (int a_n, int a_x)
{…}

Règle de codage pour les TP de Java - 5 - J. LAFORGUE
16/04/17
- 5 -
IV.5. Déclaration de variable
Le rôle d’une variable qui vient d’être déclarée doit aider à la compréhension de
l'algorithme et indiquer les liens avec les paramètres, les autres variables ... Le
commentaire relatif au rôle de la variable est placé à droite sur la même ligne que
la déclaration de celle-ci.
Par souci de lisibilité, on essayera d’aligner les commentaires des déclarations de variables d’une même
méthode.
int l_i ; // indice de parcours du tableau
tab
boolean l_termine ; // pour stopper la recherche de
l’élément x
IV.6. Déclaration des paramètres
Les paramètres d'une méthode doivent être préfixé par a_.
Exemple :
public setNom (String a_nom){nom=a_nom;}
IV.7. Déclaration d’attributs
Le rôle d’un attribut qui vient d’être déclaré doit aider à la compréhension de
l’état des objets instance de la classe. Le commentaire relatif au rôle de
l’attribut est placé au dessus de la déclaration de celle-ci et respecte le standard
javadoc.
/**
* Nom de la personne
*/
String nom ;
/**
* Attribut représentant les différents états modélisant le
* comportement d’une instance
*/
int etat ;
V
V. . I IN NS ST TR RU UC CT TI IO ON NS S
Une ligne contient au plus une instruction.