Ce projet va probablement nécessiter la rédaction d'une importante quantité de code source en Java (le plus probablement mais on en rediscutera) ou en C++ de la part de chacun d'entre nous. Il n'est pas envisageable que les différentes partie de l'application soient rédigées de manière différente en fonction des membres du groupe. C'est pourquoi je me permets de vous proposer certaines régles de rédaction de code (valable pour le Java et le C++).

Vous avez bien évidement votre mot à dire si vous n'êtes pas d'accord avec telle ou telle régle. Cependant il faudra en discuter avec tout le monde et que nous nous mettions d'accord sur une convention que chacun devra appliquer. Cette version est donc un premier jet que nous enrichirons par la suite (ou pas ^^).

La documentation

Il est nécessaire que chaque portion de code soit clairement et exhaustivement commentée. Si nous utilisons Java (cela restera valable avec le C++ mais avec quelques nuances) il faut utiliser de façon quasi systèmatique les commentaires Javadoc.

Rappels sur la Javadoc

Les packages (dans le cas où on travail en Java)

Il faudra décider d'un nom de package commun. On peut envisager quelque chose de la forme :

di4.projet.ordilot.(superviseur|ilot|commun)

Présentation générale du code

Que ce soit pour le Java ou le C++ il faut que le code soit lisible et parfaitement indenter (ce qui ne pose pas de problème avec Eclipse : il suffit de sélectionner le code et de faire CTRL + i).

Il existe des conventions et des normes pour la présentation du code (Java ou C++). Je propose d'utiliser la norme ANSI qui prend cette forme :

monBloc
{
<tabulation>le code de mon bloc;
}

Rappel : un bloc est une instructions pouvant contenir d'autres instructions. Par exemple : if, while, for, class, ...

Convention de nommage

On utilisera les conventions de nommage par défaut du langage Java. Autrement dit, celles qui ont été vues en cours.

En général on ne se servira pas des caractères spéciaux (é, è, ê, à, _, !, -, ...) pour nommer les différents composant du code source.

classes :

- première lettre en majuscule, le reste en minuscule. Exemple : public class Classe {}

- si le nom de la classe contient plusieurs mots on met la première lettre de chaque mot en majuscule. Exemple : public class LeNomDeMaClasse {}

- pas de "_"

attributs :

- s'il n'y a qu'un seul mot, on écrit tout en minuscule. Exemple : public int attribut;

- s'il y a plusieurs mots, le premier mot est en minuscule et les premières lettres des autres mots et en majuscule. Exemple : public String attributChaineDeCarateres

- pas de "_"

constantes :

- les constantes sont écrites intégralement en majuscule. Exemple : public static final int MACONSTANTE = 3;

méthodes :

- les méthodes qui ne sont pas des accesseurs ou des mutateurs, commencent, si possible, par un verbe d'action en minuscule. Exemple : public void trier(int[] tableau){}

- s'il y a plusieurs mots, le premier est, si possible, un verbe d'action en minuscule et les autres commencent par une lettre en majuscule. Exemple : public void trierTableauDEntiers(int[] tableau) {}

- pas de "_"

Conventions de nommage pour les IHM

Les composants graphiques (JTextField, JFrame, JButton, ...) doivent être préfixés par 3 lettres en minuscules permettant d'identifier rapidement le type de composant.

- JTextField -> txt Par exemple : private JTextField txtMonChampTexte;

- JButton -> btn : JButton btnMonBouton;

- JCheckBock -> chb : JCheckBox chbMaCaseACocher;

- JPanel -> pnl : JPanel pnlMonPanneau;

- JFrame -> frm : JFrame frmMaFenetre; (On ne l'utilisera pas ou pas car toutes le fenêtres doivent dériver de la classe FenetrePrincipale qui, elle, dérive de JFrame).

- les layouts -> lyt : FlowLayout lytMonLayout

- etc...