Convention de formatage du code

Encodage

Tous les fichiers seront encodés au format utf-8.

Nom des fichiers

Une classe par fichier et le fichier portera le même nom que la classe accompagné de son extension (.cpp ou .h).

Indentations

Configurez votre éditeur de texte pour avoir des indentations de 4 espaces de large (pas de caractère tabulation, uniquement des espaces).

Taille des lignes

Essayez de ne pas faire de ligne de plus de 80 caractères.

Accolades

L'accolade ouvrante sera placée a la ligne suivante (pas comme en style java).

Par ex :

int main(int argc, char *argv[])
{
    printf("Hello World\n");
    return 0;
}

Nommage et commentaires

Nous allons réutiliser en grande partie le code du Yes::Engine de Laurent Gomila donc je propose qu'on s'adapte à sa convention de nommage (sinon c'est 10k lignes de code à reprendre).

Tous les noms seront en anglais, afin d'éviter le mélange anglais/francais qui devient vite n'importe quoi. Les noms de fonctions seront plutôt des verbes alors que ceux des variables seront des noms.

  • Classes : CUnNomDeClasse
  • Classes abstraite : IUnNomDeClasse
  • Methodes : UnNomDeMethode
  • Variable passee en parametre : UnNomDeVariable
  • Variable membre : m_UnNomDeVariable
  • Variable normale : unNomDeVariable

Nous utiliserons  Doxygen pour créer automatiquement la documentation donc prenez l'habitude d'utiliser cette syntaxe.

Dans les .h :

//==========================================================
// Projet VEGETATION - Test.h
// 
// Copyright 2010
//      Jeremy Laumon        <email@domain.ext>
//      Matthieu Cambon      <email@domain.ext>
//
//      This program is free software; you can redistribute it and/or modify
//      it under the terms of the GNU General Public License as published by
//      the Free Software Foundation; either version 2 of the License, or
//      (at your option) any later version.
//      
//      This program is distributed in the hope that it will be useful,
//      but WITHOUT ANY WARRANTY; without even the implied warranty of
//      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//      GNU General Public License for more details.
//      
//      You should have received a copy of the GNU General Public License
//      along with this program; if not, write to the Free Software
//      Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
//      MA 02110-1301, USA.
//
//==========================================================

#ifndef TEST_H
#define TEST_H

//==========================================================
// En-têtes
//==========================================================

#include <iostream>

namespace ???
{

    ////////////////////////////////////////////////////////////
    /// Classe qui sert à faire le café
    ////////////////////////////////////////////////////////////

    class CTest
    {
    public :

        //----------------------------------------------------------------
        // Constructeur par défaut
        //----------------------------------------------------------------
        CTest();

        //----------------------------------------------------------------
        // Constructeur à partir d'une cafetière
        //----------------------------------------------------------------
        CTest(CCafetiere Cafetiere);

    private:

        //----------------------------------------------------------------
        // Tasses pour mettre le café
        //----------------------------------------------------------------
        CTasse Tasse1; ///< La première tasse
        CTasse Tasse2; ///< La deuxième tasse
    };

} // namespace ??

#endif // TEST_H

Dans les .cpp

//==========================================================
// Projet VEGETATION - Test.cpp
// 
// Copyright 2010
//      Jeremy Laumon        <email@domain.ext>
//      Matthieu Cambon      <email@domain.ext>
//
//      This program is free software; you can redistribute it and/or modify
//      it under the terms of the GNU General Public License as published by
//      the Free Software Foundation; either version 2 of the License, or
//      (at your option) any later version.
//      
//      This program is distributed in the hope that it will be useful,
//      but WITHOUT ANY WARRANTY; without even the implied warranty of
//      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//      GNU General Public License for more details.
//      
//      You should have received a copy of the GNU General Public License
//      along with this program; if not, write to the Free Software
//      Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
//      MA 02110-1301, USA.
//
//==========================================================


//==========================================================
// En-têtes
//==========================================================
#include <machinchose>


namespace ??
{

/////////////////////////////////////////////////////////////
/// Constructeur par défaut
////////////////////////////////////////////////////////////
CTest::CTest()
{

}


/////////////////////////////////////////////////////////////
/// Constructeur à partir d'une cafetière
///
/// \param c : Cafetière qui sera utilisée
///
////////////////////////////////////////////////////////////
CTest::CTest(CCafetiere Cafetiere)
{

}


} // namespace ??