Convention de notation

Les règles à appliquer pour devenir un bon contributeur

Tout projet possède un certain nombre de règles et conventions qui permettent à toutes personnes voulant explorer le code de le faire avec la plus grande aisance possible.

Un projet en français

Le jeu RPG est un projet où le code est rédigé en français. Pourquoi le français ? Parce que nous sommes en France et que ce projet à vocation universitaire veut être le plus accessible possible. De plus, il vous permettra de voir que le français n'est pas forcement adapté à la programmation surtout dans le cas des langages ne supportant pas les jeux de caractères riches (UTF-8 par exemple).

Les commentaires, les noms de variables, de fonctions, de méthodes, de classes, d'énumérations, d'attribut et autres doivent donc être écrit en français. Bien sur les mots clés du C++ et les fonctions des blibliotèques tierces peuvent rester en anglais.

Note sur les abréviations

Bien que fortement déconseillées, certaines abréviations sont tolérées dans la mesure où elles sont devenues courantes pour tous.

Voici une liste non exhaustive des abréviations tolérées :

• nb : nombre
• coord : coordonnée
• inf : inférieur
• sup : supérieur
• max : maximum
• min : minimum

Les casses à utiliser

Classes, attributs et méthodes

Les noms de classes sont en PascalCase, c'est-à-dire première lettre de chaque mots en majuscule et pas de séparation entre les mots

Exemples :

class Voiture;
class VoitureDeSport;

Les attributs des classes sont écrit en lower camelCase, c'est-à-dire première lettre du premier mot en minuscule puis première lettre des mots suivant en minuscule et toujours pas de séparation entre les mots. De plus, il faudra ajouter m_ devant le nom de l'attribut pour le différencier d'une variable.

Exemples :

int m_vie;
int m_vieMaximum;

Les attributs statiques de classe sont noté en lower camelCase, c'est-à-dire première lettre du premier mot en minuscule puis première lettre des mots suivant en minuscule et toujours pas de séparation entre les mots. Cependant, il n'y a pas de préfixe devant pour les différencier d'un attribut classique.

Exemples :

static int compteurDeVoiture;
++Voiture::compteurDeVoiture;

Les méthodes des classes doivent être en lower camelCase, c'est-à-dire première lettre du premier mot en minuscule puis première lettre des mots suivant en minuscule et toujours pas de séparation entre les mots.

Exemples :

void maMethodeA();
classeA.maMethodeUnPeuLongue();

Les méthodes statiques de classe doivent être en PascalCase, c'est-à-dire première lettre de chaque mots en majuscule et pas de séparation entre les mots. Ceci est pour rester constant avec l'appel des fonctions statique en C++.

Exemples :

static void MaMethodeStatique();
ClasseA::UneMethodeStatiqueDeLaClasseA();

Les attributs constants se notent en majuscule avec un blanc souligné ( _ ) pour marquer les séparations entre les mots.

Exemples :

static const int VALEUR;
static const string CHEMIN_VERS_UN_FICHIER;

Fonction, variable et constante

Les variables classiques se notent en lower camelCase, c'est-à-dire première lettre du premier mot en minuscule puis première lettre des mots suivant en minuscule et toujours pas de séparation entre les mots. Sans aucun préfixe devant.

Exemples :

int maVariableA;
string texte;

Les constantes se notent en majuscule avec un blanc souligné ( _ ) pour marquer les séparations entre les mots.

Exemples :

const int TAILLE = 10;
const string CLEF_ENCODAGE = "12e54z48zf";

Les fonctions sont nommées en snakeCase, c'est-à-dire que tout les mots sont en minuscules et les espaces sont indiqués par des blanc soulignés ( _ ).

Exemples :

void ma_super_fonction();
je_suis_une_fonction_classique();

Enumérations

Les noms d'énumérations sont écrit en PascalCase, c'est-à-dire première lettre de chaque mots en majuscule et pas de séparation entre les mots.

Exemples :

enum Couleur { Bleu=0, Rouge, Vert };
Couleur::Bleu;

Fichiers

Les fichiers sont en minuscule complet sans espace.