Règles de style

Afin d’assurer une uniformité de code, nous vous imposons de suivre des règles de style préconisées par Google. Notez que ces règles divergent légèrement des règles de style de Mbed OS et que les méthodes que vous utiliserez n’auront pas la même convention que les méthodes que vous implémenterez vous-même.

Voici quelques règles de base :

• Commencez chaque fichier par un entête avec :
  • un “copyright”;
  • le nom et l’adresse e-mail de l’auteur (ou des auteurs);
  • la date de création et/ou la date de modification;
  • une courte description du code contenu dans le fichier.
• Utilisez un langage inclusif. Dans tout le code, y compris les identifiants et les commentaires, utilisez un langage inclusif et évitez les termes que d’autres pourraient trouver irrespectueux ou offensants (tels que “master” et “slave”, “blacklist” et “whitelist”). Utilisez également un langage non genré.
• Suivez les règles suivantes pour les identifiants et autres noms :
  • Les noms de fichiers doivent être tout en minuscules et peuvent inclure des “underscores” (_).
  • Les noms de types et des classes commencent par une majuscule et sont en “CamelCase”.
  • Les noms des variables et les attributs des classes sont tous en minuscules, avec des “underscores” entre les mots. Les attributs des classes ont, en plus, un “underscore” comme suffixe.
  • Les constantes (const ou constexpr) sont nommées avec un préfix “k” suivi du nom de la constante en “CamelCase”.
  • Les fonctions commencer par une majuscule et sont en “CamelCase”.

Suivez également les dix commandements du bon programmeur à la HEIA-FR.