Skip to content

Latest commit

 

History

History
23 lines (21 loc) · 996 Bytes

NORMES.md

File metadata and controls

23 lines (21 loc) · 996 Bytes

Normes

Code

  • code et commentaires en anglais
  • variables membres de classe nommé m_variableName
  • paramètre de fonction nommé p_parameterName
  • noms de fonctions et de variables doivent décrire leur usage
  • noms de variables et paramètres seront écrit en lowerCamelCase
  • noms de fonctions et de classe seront écrit en UpperCamelCase
  • la fonction "main" doit contenir 10 lignes au maximum
  • chaque accolade doit être placée sur une ligne à part entière
  • chaque instruction doit séparer, par un espace, les variables et les opérateurs utilisés
  • chaque mot clé utilisant une condition doit avoir un espace entre lui et sa condition
  • les alias préprocesseurs doivent être écrits en majuscule
  • les constantes d'un énumérateur doivent être écrites en majuscule

Git

  • une branche par feature
  • messages de commit doivent décrire ce qui a été fait

Arborescence

  • fichiers .cpp dans src
  • fichiers .hpp dans include
  • fichiers exterieurs et lib dans externals