Project

General

Profile

Règles de codage

Plus tard dans le projet, on installera des outils d'analyse statique de code afin d'en améliorer la qualité.

  • Les fichiers doivent être encodé en UTF-8. Ceci est compatible avec l'entête HTML que l'on utilise et permet de ne pas utiliser de caractère d’échappement dans les chaines de caractères à afficher. On peut utiliser directement les caractères accentués.
  • Utilisez quatre espaces pour indenter vos fichier PHP. N'utilisez pas de tabulations.
  • Les commentaires des fonctions doivent être compatibles avec un outil de documentation automatique (à mettre en place). Une action est en cours pour adapter les commentaires des sources au format phpdoc.
  • Les commentaires des fichiers PHP applicatifs doivent être en français. On aura surement plus de contributeurs avec cette règle qu'en imposant l'anglais.