Standards à suivre¶

Les standards de l'industrie et du W3C dictent des bonnes pratiques à suivre lors de l'écriture du code.

Ainsi, en suivant le plus possible ces standards, on s'assure d'appliquer les bonnes méthodes de travail et d'utiliser les normes récentes et supportées par tous les navigateurs.

Règles générales¶

Note

"Any fool can write code that a computer can understand. Good programmers write code that humans can understand."

- Martin Fowler, Refactoring : comment améliorer le code existant, Dunod, 2019

Une bonne programmation, peu importe le langage utilisé, devrait suivre les bases du clean code.

Manuel du Clean Code sur Amazon

Règles de programmation de base pour tout langage¶

Noms significatifs pour toutes variables et noms des fonctions
Utilisation du camelCase (débute avec minuscule, suivi d'une majuscule pour les mots suivants)
Une instruction par ligne pour faciliter la lisibilité du code et aider au travail d'équipe
Lignes de maximum 80 caractères pour faciliter la lisibilité du code
Code lisible et espacé
Appliquer le principe KISS: Keep it simple and stupid
Une fonction ne devrait avoir qu'une seule utilité et son nom indiquer cette utilité

Le projet web¶

Code divisé en fichiers distincts¶

Le HTML doit être séparé du CSS et du JavaScript.

Simplifie le code
Facilite la mise à jour
Évite les répétitions inutiles
Aide au travail d’équipe

Présentation du code¶

Tout ce qui fait partie du code est écrit en minuscules ou avec le camelCase (pas les textes à afficher à l'utilisateur)
Une bonne indentation des éléments enfants et du code à l'intérieur d'un bloc
Une instruction par ligne de code
- Une balise par ligne
- Un attribut CSS par ligne
- Une instruction JS par ligne

Règles du JavaScript¶

Appeler la balise <script> au bas du HTML pour éviter qu'un script empêche le chargement de la page
Déclarer les variables avec let ou const selon le besoin, var devrait être la dernière option
- let déclare une variable qui existe uniquement au niveau du bloc où elle est définie elle peut donc libérer la mémoire dès que le bloc est terminé et n'est pas accessible de l'extérieur de ce bloc
- une variable déclarée avec let ne peut être re-déclarée plus loin dans le bloc et évite des erreurs de déclaration multiples, au contraire de var
- une variable déclarée avec const est une constante dont la valeur ne peut changer pendant le traitement et offre une sécurité supplémentaire.
  Note
  
  Dans les règles du clean code, on suggère de déclarer toute valeur fixe en constante au début du code plutôt que d'insérer des valeurs dans le code, pour ainsi en faciliter la correction et la mise à jour.
  
  Exemple :
```
 if(nombreJoueurs == 12)
 { 
    equipeComplete = true;
 }
```
  La valeur 12 devrait être conservée dans une constante au début du code plutôt qu'inscrite ainsi au milieu du traitement. Ce qui donnerait :
```
 const maxJoueursEquipe = 12;
 ...
 ...
 if(nombreJoueurs == maxJoueursEquipe)
 { 
    equipeComplete = true;
 }
```
l'id est le seul attribut obligatoirement unique pour toutes les balises. Il est donc plus sûr d'appeler les éléments d'une page avec cette valeur :
```
    document.forms["nom_de_id"]
    document.getElementById("nom_de_id")
```
Toutefois, pour extraire un formulaire, il est aussi possible d'utiliser l'attribut name dans la liste des formulaires de la page :
```
    document.forms["valeur_name"]
```
Cette méthode est plus risquée car nous pourrions oublier de donner un name unique à notre formulaire.