Suffixe Type du fichier

Règle de codage pour les TP de Java
I.
FICHIERS ET REPERTOIRES
I.1.
Suffixes
-1-
J. LAFORGUE
17/09/15
Le suffixe qui suit le nom d’un fichier indique explicitement le type des informations qu’il contient .
On utilise les suffixes suivant :
I.2.
Suffixe
Type du fichier
.java
.class
.txt
.dat
.jar
.sh ou .bat
fichier source Java
fichier objet Java
fichier de données textuel
fichier de données binaires
fichier d'archive java
scripts shells linux ou dos
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
Le nom d'un fichier (.java) contenant les sources Java doit impérativement avoir le même nom que la classe
publique qu’il contient.
II.
IDENTIFICATEURS
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.
-1-
Règle de codage pour les TP de Java
II.1.
-2-
J. LAFORGUE
17/09/15
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).
Exemples :
{
float moyenne ;
Date dateDuJour ;
.....
.....
}
int chercherMaximum () ;
boolean estVide (Liste liste) ;
package morpion ;
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.
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 ;
-2-
Règle de codage pour les TP de Java
III.
-3-
J. LAFORGUE
17/09/15
DECLARATION DES VARIABLES
On peut déclarer les variables n'importe où dans le code..
IV.
COMMENTAIRES
Un programme commentés est toujours pus compréhensible.
Trop de commentaires longs nuisent à la lecture du code (faire des revois sur des
documents annexes ou en fin de programme).
On distingue au moins les types de commentaires suivants :
le commentaire d'en-tête de fichier,
le nom du fichier
le commentaire d'en-tête de classe,
le rôle de la classe
le commentaire de déclaration d’attributs,
le rôle de l'attribut
le commentaire d'en-tête d'une méthode,
le rôle de la méthode
les rôles des paramètres
la nature de retour
les cas d'erreur (exception)
le commentaire de déclaration de variables,
le rôle de la variable (si besoin)
le commentaire de traitement,
l'objectif du traitement
le commentaire de fin de structure de contrôle
un rappel cours du début de la structure de contrôle.
Utilisé dans le cas de traitement long.
-3-