Bonjour,
Pour rappel, voici les conventions de codages sur lesquelles nous
nous sommes entendu lors de la dernière réunion :
- Les commentaires doivent toujours être en anglais (bien qu'il y
ait actuellement un mélange français/anglais)
- Chaque classe, méthode et attribut doit être associé à un
commentaire de javadoc
- Les indentations doivent être constituées de 4 espaces (et non
d'une tabulation)
- La taille des lignes doit être de 120 caractères
- Le formatage du texte doit respecter les conventions JAVA
Pour uniformiser le code du projet et ce quelque soit l'IDE utilisé,
j'ai mis en place le plugin maven-java-formatter-plugin. Chaque
sous-projet maven partage le même fichier de configuration qui est
servi par un assembly. Ce plugin prenant en entrée un fichier de
configuration du formatter d'Eclipse, il a été facile pour moi d'y
renseigner le paramétrage voulu (120 caractère de largeur, 4 espaces
pour une indentation). Je suis parti d'une configuration de
convention Java et j'ai seulement modifié une règle pour avoir un
saut de ligne entre deux propriétés d'une classe (je trouve cela
plus lisible, mais ça reste subjectif).
A chaque build Maven, l'ensemble des classes est parsé et le plugin
Maven formate les classes qui en ont besoin. Le plugin répond donc
bien aux trois derniers points des conventions plus haut.
Pour le premier point, nous avons convenu qu'on mettrait dorénavant
les commentaires en anglais et que ce n'est pas la peine de revenir
sur ceux qui existent déjà.
Il reste donc à régler le deuxième point, c'est à dire de mettre à
jour l'ensemble des commentaires de javadoc qui manquent sur le code
source produit depuis le début de la prestation.
Une dernière chose, j'ai spécifié dans le pom.xml la version du JDK
utilisée pour à la fois la compilation et le formatage. J'ai mis 1.6
car le code a été initialement écrit pour du Java SE 6.
Préférez-vous qu'on passe directement à la version 1.7 ? ou au
contraire que cela pourrait engendrer des problèmes de compatibilité
?
Adrien
--
Adrien Cheype
Ingénieur en Systèmes d'Information
Service « Informatique Scientifique et Appui aux Partenaires du
Sud »
Direction du Système d'Information (DSI)
http://www.ird.fr/dsi/
http://www.ird.fr/informatique-scientifique/
INSTITUT DE RECHERCHE POUR LE DEVELOPPEMENT
BP A5 - 98848 Nouméa - Nouvelle Calédonie
Tél. +687 260 789