Coding Policy

Eoulsan coding policy.

the following policy only applies to contributions to the Eoulsan itself (not for user plug-ins):

• All source code files must be encoded in UTF-8
• All the types names, variable names and document must be written in english
• The code must be formatted using the eoulsan-eclipse-formatter-style.xml
• All contributor to a class must add its name with the javadoc @author tag in the description of the class (except for minor bug fixes)
• A new class must contains:
• The Eoulsan header (see below)
• A description in javadoc with @author and @since tags
• All public methods must be documented with javadoc
• a package-info.java must be created for each new package
• Junit tests must be provided for all new methods of the fr.ens.biologie.genomique.eoulsan.bio package
• Don't forget to add your changes to the changes.xml for major changes and fixes issues of the bug tracker

Eoulsan files header

/*
 *                  Eoulsan development code
 *
 * This code may be freely distributed and modified under the
 * terms of the GNU Lesser General Public License version 2.1 or
 * later and CeCILL-C. This should be distributed with the code.
 * If you do not have a copy, see:
 *
 *      http://www.gnu.org/licenses/lgpl-2.1.txt
 *      http://www.cecill.info/licences/Licence_CeCILL-C_V1-en.txt
 *
 * Copyright for this code is held jointly by the Genomic platform
 * of the Institut de Biologie de l'École Normale Supérieure and
 * the individual authors. These should be listed in @author doc
 * comments.
 *
 * For more information on the Eoulsan project and its aims,
 * or to join the Eoulsan Google group, visit the home page
 * at:
 *
 *      http://outils.genomique.biologie.ens.fr/eoulsan
 *
 */

To automatically add the Eoulsan header to a new class in Eclipse, either you change your project properties or change to the globals settings:

• Project properties: Go to Project menu > Properties and select Java Code Style > Code Template > Enable project specific settings
• Global settings: Go to Preferences > Java > Code Style > Code Template
• In both case, in Code > New Java File add:

/*
 *                  Eoulsan development code
 *
 * This code may be freely distributed and modified under the
 * terms of the GNU Lesser General Public License version 2.1 or
 * later and CeCILL-C. This should be distributed with the code.
 * If you do not have a copy, see:
 *
 *      http://www.gnu.org/licenses/lgpl-2.1.txt
 *      http://www.cecill.info/licences/Licence_CeCILL-C_V1-en.txt
 *
 * Copyright for this code is held jointly by the Genomic platform
 * of the Institut de Biologie de l'École Normale Supérieure and
 * the individual authors. These should be listed in @author doc
 * comments.
 *
 * For more information on the Eoulsan project and its aims,
 * or to join the Eoulsan Google group, visit the home page
 * at:
 *
 *      http://outils.genomique.biologie.ens.fr/eoulsan
 *
 */


${package_declaration}

${typecomment}
${type_declaration}