Normes
Table des matières
Structures de dossiers
Structure standard
- css (fichiers css)
- img (fichiers images)
- js (fichiers JavaScript)
- le reste des fichiers et pages …
Au besoin
- doc (documentation)
- assets (fichiers médiatiques supplémentaires)
- pdfs (fichiers pdf)
- videos (fichiers vidéos)
- fonts (fichiers de police ex. google font)
Nomenclature de fichiers et dossiers
Les noms de fichiers doivent respecter les normes suivantes :
- Tout en minuscule (pas de camelCase)
- Ne pas avoir de caractère spécial (accent, ponctuation, etc.)
- Pas d’espace, utilisez les tirets pour séparer les mots (-)
- Garder les noms de fichiers simples et cohérents (pas de phrases complètes, pas d’article, mettre des abréviations connues)
- Pas de version 1,2,3... (mais possibilité de faire des dossiers de sauvegarde)
- On choisit une seule langue (soit le français soit l’anglais)
- IMPORTANT: Ne changez pas les noms de dossiers et fichiers du HTML5boilerplate
Normes HTML
Le contenu HTML de vos pages doit respecter les normes suivantes :
- Les balises sont en minuscule (pas de camelCase)
- Valider le code HTML au W3C
- Bien indenter le code HTML.
- Commenter les sections importantes.
- Les commentaires sont toujours en français.
- Entête de fichier commenté avec le nom de l'auteur
Normes PHP
Un nom de variable doit:
- Commencer par une lettre (alphabet ASCII)
- se composer de lettres, de chiffres et des caractères « _ » et « $ » (à l'exclusion de l’espace).
- Le nombre de caractères n'est pas précisé. => on essaie de rester court!
- PHP/JavaScript est sensible à la casse (majuscules et minuscules).
Un nom de constante doit:
- Commencer par une lettre (alphabet ASCII)
- se composer de lettres, de chiffres et des caractères « _ » et « $ » (à l'exclusion de l’espace).
- Le nombre de caractères n'est pas précisé. => on essaie de rester court!
- TOUT EN MAJUSCULE! => norme dans la plupart des langages
En vrac:
- Utilisez la camelCase lorsque vous nomez vos variables, objets, fonctions et instances
- Utilisez la PascalCase lorsque vous nommez vos constructeurs ou vos classes (orienté objet)