I – Nommage des fichiers

Deux cas :

• Le fichier contient juste du code sans être forcément dédié à une classe -> Le nom du fichier s’écrira en « snake case »
• Le fichier est rattaché à une classe -> Le nom du fichier correspondra au nom de la class

II – Entête

J’ai l’habitude de mettre une en-tête au début de mes fichiers, voici sont format :

Pour du C / C++

/****************************************************************
*
*
* < Bref description du fichier >
* Created by < autheur >
* Version : < version >
* File Creation : < date de création >
*
*
****************************************************************/ 

Pour du Python

# -*- coding: utf-8 -*-

"""
*
*
* < Bref description du fichier >
* Created by < autheur >
* Version : < version >
* File Creation : < date de création >
*
*
"""

III – Nommage des valeurs rattachées à une macro ( notamment en C / C++ )

Ces noms sont écrits en « screaming snake case ». Ces noms commencent et en terminent, par des doubles underscores ( « _ » ) si il s’agit de noms spéciales comme « __DEBUG__ » ou pour des defines de header.

Exemple : JE_SUIS_UNE_CONSTANTE

IV – Saut de ligne

Parfois, je laisse des lignes vides dans mon code… Voici les raisons principales de ces sauts de lignes:

• Si c’est la première ligne d’un bloc ( fonctions, conditions, boucles ) de plus de 3 lignes
• Si c’est la dernière ligne d’un bloc ( fonctions, conditions, boucles ) de plus de 3 lignes
• Après / Avant un bloc
• Quand je considère que je passe à une étape suivante dans mon code ( par exemple quand je passe de la déclaration des variables à la boucle principale )
• Après / Avant un commentaire qui marque la séparation d’une partie du code

V – Fonctions / méthodes

a) règles de nommage

Deux cas :

• La fonction / méthode peut être appelé directement -> on écrit son nom en « snake case »
• La fonction / méthode ne droit pas être appelé directement ( une méthode privée par exemple ) -> on écrit son nom en « snake case » en commençant par deux underscores ( « _ » )

b) Position des accolades ( C / C++ )

Les accolades ouvrantes sont situées sur la même ligne donnant le nom et la argument de la fonctions. Les accolades fermantes sont toujours sur une ligne à part.

Exemple :

int ma_fonction(int arg){
    return 3*arg;
}

VI – Nommage des variables

Toutes les variables sans exception sont nommées en snake case

VII – Blocs conditionnels / boucles

4 principes :

• La position des accolades est la même que pour les fonctions
• Si une condition est trop longue, on l’écrit sur plusieurs lignes
• La ligne de départ d’une boucle for droit toujours être sur UNE seul et même ligne
• Si un bloc fait plus de trois ligne, il devra commencer et se terminer par une ligne vide

/!\ Si on a seulement une instruction dans un if, on peut alors tout mettre sur une ligne.

VIII – Indentation

À chaque sous bloc, on ajoute une indentation

IX – Commentaire

J’applique 2 types de commentaire

a) Les commentaires pour séparer des sections de code

J’utilise deux formats dans ce cas là.

• Un format « bloc » qui est une commentaire sur plusieurs lignes qui sert à séparer deux portions de code qui ont une utilité bien distincts.
• Un format « ligne » qui est une présent pour séparer des fonctions / méthodes qui ont un but différent ( ex : calcul, mesure, affichage ) où des propriétés distinctes ( public / privé etc… )

Voici un exemple de commentaire format bloc :

Pour du C / C++

/****************************************************************
*
* Bla bla bla
*
****************************************************************/

Pour du Python

"""
*
* Bla bla bla
*
"""

Voici un exemple de commentaire format ligne:

Pour du C / C++

/******************************bla bla bla******************************/ 

Pour du Python

##############################-bla bla bla-##############################

b) Les commentaires pour expliquer les instruction du code

Si c’est pour expliquer l’action de tout un bloc, le commentaire est placé au dessus en commençant par « // » en C et « # » en Python. Si c’est pour décrire une ligne alors on place le commentaire à côté de la ligne avec un espace. On utilise toujours les caractères « // » et « # »

∞ – Have fun

Parfois, il m’arrive de mettre des petites images / signatures en ascii à la fin de mon code. Le fait d’insérer ces « easter eggs » m’amuse.