wiki:fr/conventions
developer.jelix.org is not used any more and exists only for history. Post new tickets on the Github account.
developer.jelix.org n'est plus utilisée, et existe uniquement pour son historique. Postez les nouveaux tickets sur le compte github.

Conventions de codage

Réglages de l'éditeur

Voici les règles à respecter lors de l'édition des sources de Jelix et donc ce qu'il faut configurer dans votre éditeur :

  • l'encodage utilisé dans les sources est UTF-8.
  • pour l'indentation, 4 caractères "espace" sont utilisés (pas de caractère de tabulation)
  • pas de saut de ligne avant le caractère de début de bloc {
  • un espace avant la parenthèse ouvrante et fermante au niveau des mots clés (if, foreach etc...)
  • idem pour les { et }
  • un espace autour des opérateurs

Exemple :

    if ($truc > 0) {
        $bla = $truc;
    } else {
        ...
    }

Créer un nouveau fichier

Vous devez mettre un cartouche en tête du source php :

/**
* @package     package
* @subpackage  sous-package
* @author      votre nom
* @contributor
* @copyright   2007 votre nom
* @link        http://www.jelix.org
* @licence     GNU Lesser General Public Licence see LICENCE file or http://www.gnu.org/licenses/lgpl.html
*/

package en général, c'est Jelix. Sous-package, pour Jelix, c'est le nom du répertoire dans lib/jelix/.

Vous devez indiquer votre nom sur la ligne @author et le copyright sur la ligne @copyright.

La licence pour les fichiers de Jelix doit être la LGPL. Pour jelix-scripts c'est GPL. Pour les modules c'est au choix.

Modifier des sources existantes

Pour des fichiers que vous modifiez et dont vous n'êtes pas l'auteur, vous devez indiquer votre nom dans le cartouche d'entête du source :

  • au niveau de la ligne @contributor
  • ajouter une ligne @copyright avec votre copyright.

Bien sûr, modifier un fichier existant implique que vous acceptez que vos modifications soient publiées sous la licence indiquée dans le cartouche.

Fichier CREDITS

Ajouter votre nom dans le fichier lib/jelix/CREDITS avec une ligne expliquant la contribution

le code

Le code doit être le plus léger et performant possible. Il doit permettre une utilisation simple.

Les commentaires

seul /*..*/ ou sont autorisés pour les commentaires. Le # doit être réservé pour les instructions du préprocesseur.


Retour au sommaire

Last modified 7 years ago Last modified on Mar 4, 2012, 2:18:47 PM