Guidelines sur le code

Style du Javascript

• Pour ce qui est des conventions de code, essayer de suivre : les conventions de Douglas Crockford
• L'indentation est de 4 espaces, ne pas utiliser de tabs (softtabs). Pour vous aider, il est recommandé d'installer [jshint] (http://www.jshint.com/install/) sur votre éditeur
  • Sur Sublime Text, il suffit d'aller dans l'onglet Préférences > Settings - Default et de modifier la ligne 49 : "translate_tabs_to_spaces" et de mettre la valeur à true.

Nommage des variables

• Utiliser exclusivement l'anglais.
• Le nom doit être le plus explicite possible, ne pas hésiter à passer du temps à choisir. En cas de doute, demander de l'aide à un collègue.
• Le nom doit être si possible court, mais uniquement dans la mesure où il reste explicite.
• Ne pas utiliser les abréviations, sauf les usuelles, par exemple x et y pour la position, i ou j pour un index d'une boucle
• Pour indiquer un nombre de choses, utiliser count plutôt que number : usersCount, articlesCount, playersCount, etc…
• Ne pas hésiter à utiliser le plurier : préférer par exemple entities à entityList