Guide de Style

Style

  1. Lisez le Guide de Style C++ de Google (particulièrement pour ce qui est du non-formatting)
  2. Lancez clang-format avec -style=file (ce qui utilise notre fichier format .clang-format) bash $ cd kovri/ && clang-format -i -style=file src/path/to/my/file
  3. Lancez cpplint (qui utilise notre fichier CPPLINT.cfg) pour capturer tous les problèmes qui ont été manqués par clang-format bash $ cd kovri/ && cpplint src/path/to/my/file && [éditez le fichier manuellement pour résoudre les problèmes détectés]

Plugins

Voici ce qui n’est pour l’instant pas capturé par clang-format et qui diffère du style C++ proposé par Google

  • Évitez le préfixe k et MACRO_TYPE pour les constantes
  • Utilisez les 3 slashs /// C++ comments quand vous documentez pour Doxygen
  • Essayez de documenter tout votre travail pour Doxygen au fur et à mesure
  • Si l’anonymat est important pour vous, essayez de fondre votre style sur celui des autres contributeurs

Vérifications facultatives

  1. cppdep pour la dépendance des composants, l’isolation et les include.
  2. cppcheck pour les analyses statiques (en complément à Coverity).
  3. lizard pour la complexité cyclomatique.