Aller au contenu

Règles départementales de programmation

Voici les règles de programmation adoptées au département d'informatique et qu enous appliquerons pour les scripts JavaScript produits dans le cadre du cours d'Interfaces Web.

RÈGLES DE PROGRAMMATION

Ça ne plante pas, mais...

Un programme qui FONCTIONNE n'est PAS NÉCESSAIREMENT un BON programme !

En plus de produire des résultats exacts, ce qui est la moindre des choses, un BON programme doit comporter les qualités suivantes :

  • Bonne lisibilité générale
  • Efficacité minimale…au moins !
  • Respect des normes d'entreprise

Des points pourront être enlevés en tout temps pour un programme de qualité insuffisante.

Normes obligatoires du département d'informatique :

  • Décalages significatifs ;
  • Termes français pour tous les affichages (message et écran) ;
  • Des lignes de code de longueur acceptable ;
  • Une seule instruction par ligne ;
  • Prioriser un code lisible au détriment des commentaires ;
  • Aucune variable globale (sauf exception justifiée par le professeur) ;
  • Noms de variables et de méthodes/fonctions significatifs et comportant au besoin des lettres majuscules ;
  • Méthodes/fonctions simple : ne doit faire qu'une seule chose ;

Bon à savoir

N'oubliez pas que dans Visual Studio Code, lorsque vous faites un click droit dans le code, vous avez une option intitulée "Format Document" pour s'assurer d'une belle présentation du code.