Deux cas :
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 >
*
*
"""
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
Parfois, je laisse des lignes vides dans mon code… Voici les raisons principales de ces sauts de lignes:
Deux cas :
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;
}
Toutes les variables sans exception sont nommées en snake case
4 principes :
/!\ Si on a seulement une instruction dans un if, on peut alors tout mettre sur une ligne.
À chaque sous bloc, on ajoute une indentation
J’applique 2 types de commentaire
J’utilise deux formats dans ce cas là.
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-##############################
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 « # »
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.