Conventions de codage - Cantharella
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
Bonjour, Il me semble que passer de Java 6 à 7 implique un certain nombre de changements, à commencer par passer de Tomcat 6 à 7 avec tout ce que cela implique (Servlet 3...). Voir : http://tomcat.apache.org/migration-7.html#Migrating_from_6.0.x_to_7.0.x A prévoir aussi, la migration vers Jetty 8. Mickaël 2013/2/18 Adrien Cheype <adrien.cheype@ird.fr>
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é ?
Le 18/02/2013 10:28, Mickaël Tricot a écrit :
Bonjour,
Il me semble que passer de Java 6 à 7 implique un certain nombre de changements, à commencer par passer de Tomcat 6 à 7 avec tout ce que cela implique (Servlet 3...). Voir : http://tomcat.apache.org/migration-7.html#Migrating_from_6.0.x_to_7.0.x A prévoir aussi, la migration vers Jetty 8. Il n'y a pas de rapport entre Java 7 et Tomcat 7.
Tomcat 7, impose une JRE 6 ou supérieur et peut faire tourner des servlet 2.5 (voire avant). Les servlet 3.0 sont d'ailleurs inclut dans la norme JEE 6 et non JSE 7. -- Éric Chatellier - Code Lutin Tel: 02.40.50.29.28 - http://www.codelutin.com
Tant mieux ! :) Je crois avoir lu que certains ont eu des problèmes à faire tourner Tomcat 6 + Java 7, mais ce sont peut-être des problèmes spécifiques à leur infrastructure ou applications. 2013/2/18 Eric Chatellier <chatellier@codelutin.com>
Il n'y a pas de rapport entre Java 7 et Tomcat 7.
Tomcat 7, impose une JRE 6 ou supérieur et peut faire tourner des servlet 2.5 (voire avant).
Les servlet 3.0 sont d'ailleurs inclut dans la norme JEE 6 et non JSE 7.
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é ? Java 1.6 étant en fin de vie (février 2013) je serais plutôt pour profiter des nouveaux apport de java 7. Cela ne pose par trop de problème sur une application (par opposition à une
Le 18/02/2013 10:14, Adrien Cheype a écrit : librairie). Le seul soucis est que pour installer cantharella, il faudra disposer de Java 7 et il n'est pas évident d'avoir la dernière version à jour dans tout les cas pour les administrateur qui voudrait l'installer. -- Éric Chatellier - Code Lutin Tel: 02.40.50.29.28 - http://www.codelutin.com
participants (3)
-
Adrien Cheype -
Eric Chatellier -
Mickaël Tricot