Documentation:Autres

From Gameforge Official Website

Contents 1 Style de codage (Coding Style) 1.1 Pouquoi ? 1.2 C++ 1.2.1 Les Fichiers 1.2.1.1 Extension 1.2.1.2 Nom de fichier 1.2.2 Classes 1.2.2.1 Nom 1.2.2.2 Attribue 1.2.2.2.1 Attribue constant 1.2.2.2.2 Variable locale 1.2.2.3 Enum 1.2.2.4 Méthode 1.2.3 Namespaces 1.2.4 Macro 1.2.5 Les accolades 1.2.6 Espace et tabulation 1.2.7 Entête de chaque fichier

Style de codage (Coding Style)

Pouquoi ?

Le but "ultime" est que si toto fait une classe et que titi n'est aucun probleme a relire le code. Cela permet d'uniformiser le code produit et d'en facilité la lecture.

C++

Le coding style est définie a partie d'expression régulière [1].

Les Fichiers

Extension

• Classe : *.cc
• Headers : *.hh et *.hxx (dans le cas des template on a besoin de separer en deux fichiers)

Nom de fichier

Pour ta classe TotorPoilu, on aura :

• TotorPoilu.cc
• TotorPoilu.hh

et si c'est une template :

• TotorPoilu.hh
• TotorPoilu.hxx

Classes

Nom

Reg exp : ([A-Z][a-z]*)+

cad :

• TotorPoileu.cc --> oki
• Totor_Poileu.cc --> ko
• TTotorPoileu.cc --> oki

Attribue

Reg exp : m([A-Z][a-z]*)+

Attribue constant

Reg exp : m[A-Z]+(\_[A-Z]+)*

Variable locale

Reg exp : [a-z]+([A-Z][a-z]*)*

Enum

Reg exp : [A-Z]+(\_[A-Z]+)*

Méthode

Reg exp : [a-z]+([A-Z][a-z]*)*

Namespaces

Que des lettres minuscules.

Macro

Reg exp : \_\_[A-Z]*(\_[A-Z]+)*\_\_

Les accolades

Code:

if( a == b)
{
  cout << "ee" << endl;
}

Espace et tabulation

On utilise que des espaces pas de tabulation. avec une indentation de deux espaces

Exemple 1

#ifndef __DEBUG_HH__
#  define __DEBUG_HH__
...
..
.
#endif 

Exemple 2 :

namespace pimp
{
  class IdData
  {
    public:
      IdData(const IdData &id);

Entête de chaque fichier

/*
 * Copyright (c) GameForge 2006
 * 
 * Use, modification and distribution is subject to 
 * the GNU General Public License V2 or later.
 *
 * Licence : http://www.gnu.org/copyleft/gpl.html
 *
 * File          :
 * Created on    :
 * Author        :
 * 
 * Last modified :
 * Author        :
 * Description   :
 */

Pour vim [2], il existe un script qui permet de créer et updater facilement cet entête.