Spécifications du code JavaScript

Jfichiers javascript

Les programmes JavaScript doivent être enregistrés indépendamment dans des fichiers avec le suffixe .js.

Le code JavaScript ne doit pas être inclus dans les fichiers HTML, sauf s'il s'agit d'un morceau de code spécifique qui appartient uniquement à cette section. Le code JavaScript en HTML augmentera considérablement la taille du fichier et il ne pourra pas être mis en cache ou compressé.

Indentation

L'unité d'indentation est composée de quatre espaces. Évitez d'utiliser la touche Tab pour mettre en retrait (même au 21e siècle), il n'existe toujours pas de norme unifiée pour la longueur des tabulations. Bien que l'utilisation d'espaces augmente la taille du fichier, elle est presque négligeable sur un réseau local et peut être éliminée lors du processus de minimisation.

Longueur de chaque ligne

Évitez de dépasser 80 caractères par ligne. Lorsqu’une instruction ne tient pas sur une seule ligne, envisagez de la mettre à la ligne. Dans les symboles d'opération, il est préférable de mettre une nouvelle ligne après une virgule. Renvoyer les lignes après les opérateurs réduit le risque que les erreurs de copier-coller soient masquées par des points-virgules. La ligne suivante doit être en retrait de 8 espaces.

Commentaires

Ne lésinez pas sur les commentaires. Il est très utile de laisser des informations aux personnes qui auront besoin de comprendre votre code à l'avenir (peut-être vous-même). Les commentaires doivent être aussi bien rédigés et clairs que le code sur lequel ils commentent. Un peu d'humour de temps en temps, c'est encore mieux. N'oubliez pas d'éviter d'être verbeux ou émotif.

Il est également important de mettre à jour les commentaires en temps opportun. De mauvais commentaires peuvent rendre un programme plus difficile à lire et à comprendre.

Déclaration de variable

Toutes les variables doivent être déclarées avant utilisation. JavaScript ne l'exige pas, mais il facilite la lecture du programme et facilite la recherche de variables non déclarées (elles seront compilées en variables globales).

Placez l'instruction var au début de la fonction.

Il est préférable de mettre l'instruction de déclaration de chaque variable sur une ligne distincte et d'ajouter des commentaires. Toutes les variables sont triées par ordre alphabétique.

var currentEntry; // Sélection actuelle

var niveau; // Niveau d'indentation

var size; // Taille de la table

Déclaration de fonction

Toutes les fonctions doivent être déclarées avant utilisation. La déclaration de la fonction interne suit l'instruction var. Cela peut aider à déterminer quelles variables entrent dans la portée de la fonction.

Il ne doit y avoir aucun espace entre le nom de la fonction et ((crochet gauche).) (crochet droit) et {(accolade gauche) qui démarre le corps du programme. Un espace doit être inséré. Les corps des programmes de fonction doivent être en retrait de quatre espaces. } (accolade droite) est aligné avec le début de la ligne de code qui déclare la fonction.

fonction externe(c, d) {                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

}

Nom

Le nom de la variable doit être composé de 26 Il se compose de lettres majuscules et minuscules (A..Z,a..z), de 10 chiffres (0..9) et de _ (trait de soulignement). Évitez d'utiliser des caractères internationalisés (comme le chinois) car ils ne sont pas faciles à lire et à comprendre partout. N'utilisez pas $ (signe dollar) ou (barre oblique inverse) dans les noms.

N'utilisez pas _ (trait de soulignement) comme premier caractère d'un nom de variable. Il est parfois utilisé pour représenter des variables privées, mais en fait JavaScript ne fournit pas la fonction de variables privées. Si les variables privées sont importantes, utilisez le formulaire de membre privé. Cette convention de dénomination trompeuse doit être évitée.

La plupart des noms de variables et de méthodes doivent commencer par une lettre minuscule.

Les noms de constructeurs qui doivent être utilisés avec new doivent commencer par une lettre majuscule. JavaScript ne générera aucune erreur de compilation ou d'exécution lorsque new est omis. Si vous oubliez d'ajouter du nouveau, de mauvaises choses se produiront (comme être traité comme une fonction normale), donc mettre en majuscule le nom du constructeur est le seul moyen d'éviter que cela se produise.

Les variables globales doivent être en majuscules. (JavaScript n'a pas de macros ni de constantes, il n'y aura donc pas de malentendus)

Déclaration

Déclaration simple

Chaque ligne contient au plus une déclaration. Mettez ; (point-virgule) à la fin de chaque instruction simple. Notez qu'une instruction d'affectation de fonction ou d'affectation d'objet est également une instruction d'affectation et doit se terminer par un point-virgule.

JavaScript peut traiter n'importe quelle expression comme une instruction. Cela peut facilement masquer certaines erreurs, notamment celles causées par l'ajout d'un point-virgule par erreur. Une expression doit être traitée comme une instruction distincte uniquement lorsqu'elle est affectée et appelée.

Instruction complexe

Une instruction composée est une séquence d'instructions entourée de { } (accolades).

La déclaration ci-jointe doit être mise en retrait de quatre espaces supplémentaires. { (accolade gauche) doit être à la fin de l'exécution d'une instruction composée. } (accolade droite) doit être aligné avec le début de la ligne de { (accolade gauche) Les accolades doivent être utilisées dans toutes les instructions composées, même s'il n'y a qu'une seule instruction, lorsqu'elles font partie d'une structure de contrôle, comme un if ou pour déclaration. Cela évitera les erreurs lors de l’ajout ultérieur d’instructions.

Marquage

Le marquage des instructions est facultatif, seules les instructions suivantes doivent être marquées : while, do, for, switch.

instruction return

N'utilisez pas ( ) (crochets) pour placer la valeur de retour dans une instruction return avec une valeur de retour. Si une expression est renvoyée, elle doit se trouver sur la même ligne que le mot-clé return pour éviter les erreurs accidentelles de point-virgule.

instruction continue

Évitez d'utiliser l'instruction continue. Cela peut facilement rendre obscure la logique d’un programme.

avec déclaration

N'utilisez pas la déclaration with.

Vierge

L'utilisation de lignes vides pour séparer les blocs de code logiquement liés peut améliorer la lisibilité du programme.

L'espace doit être utilisé dans les situations suivantes :

• Les mots clés suivants ((crochet gauche) doivent être séparés par un espace. while (true) {
• Paramètres de fonction Il doit y avoir pas d'espace entre ((crochet gauche) et ((crochet gauche)). Cela permet de distinguer les mots-clés des appels de fonction.

• Tous les opérateurs binaires sauf .(point) et ((crochet gauche) et [ (carré gauche parenthèse) doit être séparé de l'opérande par un espace.

• Il ne doit y avoir aucun espace entre un opérateur unaire et son opérande, sauf si l'opérateur est un mot, tel que

. ; (point-virgule) dans une section de contrôle, telle qu'une instruction for, doit être suivi d'un espace

• Chaque , (virgule) doit être suivi d'un espace

.

Règles de définition de l'objet :

Mettez l'accolade ouvrante et le nom de la classe sur la même ligne

Il y a un espace entre les deux points et la valeur de l'attribut. chaînes, et il n'est pas nécessaire d'ajouter une virgule après la dernière paire attribut-valeur 🎜>

Extension de fichier

.

Le suffixe du fichier HTML peut être .html (ou r .htm).

Le suffixe du fichier CSS est .css.

Le suffixe du fichier JavaScript est .js .

Utilisez des noms de fichiers en minuscules

La plupart des serveurs Web (Apache, Unix) sont sensibles à la casse : london.jpg n'est pas accessible via Londres. .jpg .

Les autres serveurs Web (Microsoft, IIS) ne sont pas sensibles à la casse : london.jpg est accessible sous London.jpg ou london.jpg.

Vous devez conserver un style cohérent et nous vous recommandons d'utiliser systématiquement les noms de fichiers en minuscules.