Annexe H  Conventions d'écriture des programmes Java

H.1  Fichiers

• Commentaires de début, comportant entre autres le nom de la classe, le nom de l'auteur, la date de création et de dernière mise à jour.
• Déclaration du package éventuel, suivie des importations éventuelles, par exemple :

  package dupont.exercices;
  import java.awt.*;
  

• Définition de la classe ou de l'interface (s'il y en a plusieurs, la classe ou interface publique en premier). Cette définition se fait dans l'ordre suivant :
  

  Documentation de la classe ou de l'interface (commentaires /** ... */)	cf. § H.3
  Déclaration de la classe ou de l'interface	Exemple : public class Banque
  Commentaires de programmation (/* ... */), si nécessaire, c'est-à-dire commentaires généraux sur la mise en oeuvre de la classe, qui n'ont pas leur place dans la documentation	cf. § H.3
  Déclaration des variables de classe (static)	D'abord les public, puis les protected, puis les private
  Déclaration des variables d'instance	D'abord les public, puis les protected, puis les private
  Constructeurs
  Méthodes	Les regrouper de préférence par grandes fonctionnalités, pour rendre le tout le plus lisible possible

H.2  Indentation

class Test extends Object {
    int var1;
    int var2;

    Test(int i, int j) {
        var1 = i;
        var2 = j;
    }

    int methodeVide() {}

    void calculs() {
        ...
        if (var1 > 0) {
            var2--;
            ...
        }
        ...
        while (var1 != var2) {
            ...
        }
    }
    ...
}

• après une virgule,
• avant un opérateur,
• au niveau de parenthésage le plus englobant possible,
• aligner la nouvelle ligne avec le début de l'expression qui est au même niveau à la ligne précédente,
• si tout ce qui précède marche mal, indenter tout simplement de 4 ou 8 espaces.

fonc(expressionTresLongue1, expressionTresLongue2, expressionTresLongue3,
     expressionTresLongue4, expressionTresLongue5);

var = fonc1(expressionTresLongue1,
            fonc2(expressionTresLongue2,
                  expressionTresLongue3));

impotAPayer = ageDuCapitaine * (longueur + largeur - hauteur)
              + 4 * tailleChemise;

if ((condition1 && condition2)
        || (condition3 && condition4)
        || (condition5 && condition6)) {
    faireQuelqueChose()   // reste lisible
    ...
}

H.3  Commentaires

H.3.1  Commentaires de programmation

1. Blocs de commentaires : servent à expliciter des fichiers, des méthodes, des structures de données et des algorithmes. Les précéder d'une ligne blanche, et les présenter comme suit :

   /*
    * Ceci est un bloc de commentaire.
    * Il peut comporter plusieurs lignes, chacune commençant par une
    * étoile entourée de deux espaces, pour la lisibilité de l'ensemble
    */
   

   
   
   
2. Une ligne de commentaire : si votre commentaire ne tient pas sur une ligne, ne faites pas suivre deux lignes de commentaires ; utilisez de préférence un bloc de commentaires. Exemple de ligne de commentaire :

   if (condition) {
       /* Traiter le cas où tout va bien */
       ....
   }
   

   
   
   
3. Commentaires de fin de ligne : ils peuvent prendre les deux formes /* ... */ ou // ..., la deuxième servant en outre à "masquer" une partie du code en cours de développement ou de déboguage. Exemples :

   if (a == 2) {
       return TRUE;      /* Cas particulier */
   }
   else if (toto > 1) {
       // Permuter les deux valeurs
       ...
   }
   else
       return FALSE;     // Explications
   
   // if (tata > 1) {
   //
   //    // Trois valeurs à permuter
   //    ...
   //}
   //else
   //    return FALSE;
   

H.3.2  Commentaires de documentation

• Pour une classe :

      
  /**
   * Cette classe est une spécialisation de la classe générale des clients.
   * @author   Jean Lingénieur
   * @see      Client
   */
  class ClientPrivilegie extends Client
  {
  ...
  }
    

  
  
  
• Pour une méthode :

      /**
       * Rend la somme TTC à payer après application de la TVA et d'une
       * réduction éventuelle.
       * @param    sommeHT le montant hors taxes et avant réduction de la commande
       * @return   montant TTC net à payer
       */
      double sommeTTC(double sommeHT) {
          ...
      }
  

H.4  Déclarations et instructions

int total;
...
fonction() {
    if (condition) {
        int total;       // à éviter !!
        ...
    }
    ...
}

compte++; valeur -= compte;    // à éviter !!

H.5  Noms

1

href="http://java.sun.com/docs/codeconv/html/CodeConventionsTOC.doc.html" SIZE=5>target="_blank">http://java.sun.com/docs/codeconv/html/CodeConventionsTOC.doc.html

2

http://java.sun.com/j2se/javadoc/