Guide de style JavaScript – Bien choisir son serveur d impression
Toujours utiliser les mêmes conventions de codage pour tout votre JavaScript
projets.
Sommaire
Conventions de codage JavaScript
Les conventions de codage sont directives de style pour la programmation.
Ils couvrent généralement:
- Règles de dénomination et de déclaration pour les variables et les fonctions.
- Règles d'utilisation des espaces, de l'indentation et des commentaires.
- Pratiques et principes de programmation
Conventions de codage qualité sécurisée:
- Améliore la lisibilité du code
- Facilite la maintenance du code
Les conventions de codage peuvent être des règles documentées que les équipes doivent suivre, ou simplement être votre pratique de codage individuelle.
Cette page décrit les conventions générales du code JavaScript utilisées par W3Schools.
Vous devriez également lire le chapitre suivant "Meilleures pratiques" et apprendre à éviter les pièges de la programmation.
Noms de variables
Chez W3schools, nous utilisons affaire de chameau pour les noms d'identifiant (variables et fonctions).
Tous les noms commencent par un lettre.
Au bas de cette page, vous trouverez une discussion plus large sur le nommage
règles.
firstName = "John";
lastName = "biche";
prix = 19,90;
taxe = 0,20;
fullPrice = prix + (prix * taxe);
Espaces autour des opérateurs
Toujours mettre des espaces autour des opérateurs (= + – * /) et après les virgules:
Exemples:
var x = y + z;
valeurs var = [« Volvo », « Saab »,
« Fiat »];
Indentation de code
Toujours utiliser 2 espaces pour l'indentation des blocs de code:
Les fonctions:
fonction toCelsius (fahrenheit)
retour (5/9) * (fahrenheit – 32);
N'utilisez pas de tabulateurs pour l'indentation. Différents éditeurs interprètent les onglets différemment.
Règles de déclaration
Règles générales pour les déclarations simples:
- Terminez toujours une simple déclaration par un point-virgule.
Exemples:
valeurs var = [« Volvo », « Saab »,
« Fiat »];
var personne =
prenom: "John",
nom: "biche",
âge: 50 ans,
couleur des yeux:
"bleu"
;
Règles générales pour les instructions complexes (composées):
- Placez le support d’ouverture à la fin de la première ligne.
- Utilisez un espace avant le support d’ouverture.
- Placez le crochet de fermeture sur une nouvelle ligne, sans espaces de début.
- Ne terminez pas une déclaration complexe par un point-virgule.
Les fonctions:
fonction toCelsius (fahrenheit)
retour (5/9) * (fahrenheit – 32);
Boucles:
pour (i = 0; i <5; i ++)
x + = i;
Conditions:
si (temps <20)
voeux = "bonne journée";
autre
voeux = "bonsoir";
Règles d'objet
Règles générales pour les définitions d'objet:
- Placez le crochet d’ouverture sur la même ligne que le nom de l’objet.
- Utilisez deux points plus un espace entre chaque propriété et sa valeur.
- Utilisez des guillemets autour des valeurs de chaîne, pas autour des valeurs numériques.
- N'ajoutez pas de virgule après la dernière paire propriété-valeur.
- Placez le crochet de fermeture sur une nouvelle ligne, sans
espaces principaux. - Terminez toujours une définition d'objet par un point-virgule.
Exemple
var personne =
prenom: "John",
nom: "biche",
âge: 50 ans,
couleur des yeux:
"bleu"
;
Les objets courts peuvent être écrits compressés, sur une ligne, en utilisant uniquement des espaces
entre propriétés, comme ceci:
var person = prénom: "John", nom: "biche", âge: 50 ans, couleur des yeux: "bleu";
Longueur de ligne <80
Pour plus de lisibilité, évitez les lignes de plus de 80
personnages.
Si une déclaration JavaScript ne tient pas sur une seule ligne, le meilleur endroit pour rompre
c'est après un opérateur ou une virgule.
Conventions de nommage
Utilisez toujours la même convention de nommage pour tout votre code. Par exemple:
- Noms de variable et de fonction écrits en tant que affaire de chameau
- Variables globales écrites en MAJUSCULE (Nous ne le faisons pas, mais c'est
assez fréquent) - Constantes (comme PI) écrites en MAJUSCULE
Si vous utilisez hyp poule, affaire de chameau, ou
under_scores dans des noms de variables?
C’est une question souvent abordée par les programmeurs. La réponse dépend de qui vous
demander:
Des traits d'union en HTML et CSS:
Les attributs HTML5 peuvent commencer par data (data-quantité, data-price).
CSS utilise des traits d'union dans les noms de propriété (taille de police).
Les traits d'union peuvent être confondus avec des tentatives de soustraction. Les traits d'union ne sont pas autorisés dans les noms JavaScript.
Underscores:
De nombreux programmeurs préfèrent utiliser des traits de soulignement (date_of_birth), en particulier en SQL
bases de données.
Les soulignements sont souvent utilisés dans la documentation PHP.
PascalCase:
PascalCase est souvent préféré par les programmeurs C.
affaire de chameau:
camelCase est utilisé par JavaScript lui-même, par jQuery et autre JavaScript
bibliothèques.
Ne commencez pas les noms avec un signe $. Cela vous mettra en conflit avec de nombreux noms de bibliothèques JavaScript.
Chargement de JavaScript en HTML
Utilisez une syntaxe simple pour charger des scripts externes (l'attribut type n'est pas
nécessaire):
Accéder aux éléments HTML
L'utilisation de styles HTML "mal rangés" peut entraîner des erreurs de JavaScript.
Ces deux instructions JavaScript produiront des résultats différents:
var obj =
getElementById ("Démo")
var obj = getElementById ("demo")
Si possible, utilisez la même convention de dénomination (que JavaScript) en HTML.
Visitez le guide de style HTML.
Extensions de fichier
Les fichiers HTML doivent avoir un .html extension (pas .htm).
Les fichiers CSS doivent avoir un .css extension.
Les fichiers JavaScript doivent avoir un .js extension.
Utiliser des noms de fichier en minuscule
La plupart des serveurs Web (Apache, Unix) sont sensibles à la casse des noms de fichiers:
london.jpg est inaccessible en tant que London.jpg.
Les autres serveurs Web (Microsoft, IIS) ne sont pas sensibles à la casse:
london.jpg est accessible en tant que London.jpg ou london.jpg.
Si vous utilisez une combinaison de majuscules et de minuscules, vous devez être extrêmement
cohérent.
Si vous passez d'un serveur insensible à la casse à un serveur sensible à la casse, même petit
les erreurs peuvent casser votre site web.
Pour éviter ces problèmes, utilisez toujours des noms de fichiers en minuscule (si possible).
Performance
Les conventions de codage ne sont pas utilisées par les ordinateurs. La plupart des règles ont
peu d'impact sur l'exécution des programmes.
L'indentation et les espaces supplémentaires ne sont pas significatifs dans les petits scripts.
Pour le code en développement, la lisibilité doit être privilégiée. Production plus importante
les scripts doivent être minifiés.
Articles relatifs:
Commentaires
Laisser un commentaire