Normes du code JavaScript
Tous les projets JavaScript appliquent les mêmes normes.
Spécifications du code JavaScript
Les spécifications du code incluent généralement les aspects suivants :
Règles de dénomination des variables et des fonctions
Espaces, indentation, règle d'utilisation des commentaires.
Autres spécifications couramment utilisées...
Le code standardisé peut être plus facile à lire et à maintenir.
Les spécifications du code sont généralement stipulées avant le développement et peuvent être négociées et définies avec les membres de votre équipe.
Nom de la variable
Il est recommandé d'utiliser camelCase pour les noms de variables :
firstName = "John";
lastName = "Doe";
prix = 19,90;
taxe = 0,20;
fullPrice = prix + (prix * taxe);
Espace et opérateur
Opérateur habituel ( = + - * / ) Vous devez ajouter des espaces avant et après :
Exemple :
var x = y + z;
var valeurs = ["Volvo", "Saab", " Fiat" ];
Indentation du code
Utilisez généralement 4 espaces pour indenter les blocs de code :
Fonction :
fonction toCelsius(fahrenheit) {
return (5 / 9) * (fahrenheit - 32);
}
Il n'est pas recommandé d'utiliser la touche TAB pour abréger Parce que différents éditeurs interprètent différemment la touche TAB.
Règles de déclaration
Règles générales pour les déclarations simples :
Une déclaration se termine généralement par un symbole.
Exemple :
var valeurs = ["Volvo", "Saab", "Fiat"];
var personne = {
prénom : "John ",
lastName : "Doe",
age : 50,
eyeColor : "blue"
};
Règles générales pour les déclarations complexes :
will être dépensé à gauche. Les parenthèses sont placées à la fin de la première ligne.
Ajoutez un espace avant l'accolade gauche.
Mettez l'accolade fermante sur sa propre ligne.
Ne terminez pas une instruction complexe par un point-virgule.
Fonction :
fonction toCelsius(fahrenheit) {
retour (5/9) * (fahrenheit - 32);
}
Boucle :
pour (i = 0; i < 5; i++) {
x += i;
}
Instruction conditionnelle :
if (heure < 20) {
salutation = "Bonne journée";
} else {
salutation = "Bonsoir";
>
Règles d'objet
Règles pour les définitions d'objets :
Placez l'accolade ouvrante sur la même ligne que le nom de la classe.
Il y a un espace entre les deux points et la valeur de l'attribut.
Utilisez des guillemets doubles pour les chaînes, mais pas pour les nombres.
N'ajoutez pas de virgule après la dernière paire attribut-valeur.
Mettez l'accolade droite sur sa propre ligne et terminez-la par un symbole.
Exemple :
var personne = {
prénom : "John",
nom de famille : "Biche",
âge : 50,
couleur des yeux : "bleu "
};
Le code objet court peut être écrit directement sur une seule ligne :
Exemple :
var person = {firstName:"John", lastName : "Biche", age:50, eyeColor:"blue"};
Les caractères de chaque ligne de code doivent être inférieurs à 80
Afin d'en faciliter la lecture, il est recommandé que le les caractères de chaque ligne doivent être inférieurs à 80.
Si une instruction JavaScript dépasse 80 caractères, il est recommandé de couper la ligne après l'opérateur ou la virgule.
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
</head>
<body>
<h1>我的 Web 页面</h1>
<p>
建议在运算符或者逗号后换行。
</p>
<p id="demo"></p>
<script>
document.getElementById("demo").innerHTML =
"Hello php.";
</script>
</body>
</html>Règles de dénomination
Généralement, les règles de dénomination de nombreux langages de code sont similaires, par exemple :
Les variables et les fonctions sont camelCase
Les variables globales sont en majuscules (MAJUSCULES)
Les constantes (telles que PI) sont en majuscules (MAJUSCULES)
Utilisez-vous ces règles pour nommer les variables : hyp-hens, camelCase, ou under_scores ?
Caractère barre (-) en HTML et CSS :
Les attributs HTML5 peuvent être préfixés par data- (ex : data-quantité, data-price).
CSS utilise - pour concaténer les noms de propriétés (font-size).
- est généralement considérée comme une soustraction en JavaScript, elle n'est donc pas autorisée.
Souligné :
De nombreux programmeurs préfèrent utiliser des traits de soulignement (tels que : date_of_birth), en particulier dans les bases de données SQL.
Le langage PHP utilise généralement des traits de soulignement.
PascalCase :
PascalCase est plus courant en langage C.
Cas Camel :
Le cas Camel est généralement recommandé en JavaScript, et jQuery et d'autres bibliothèques JavaScript utilisent le cas Camel.
Ne commencez pas les noms de variables par $ car cela entrerait en conflit avec de nombreuses bibliothèques JavaScript.
HTML Charger le fichier JavaScript externe
Charger le fichier JavaScript en utilisant un format concis (l'attribut type n'est pas requis) :
< ;script src ="myscript.js">
Utiliser JavaScript pour accéder aux éléments HTML
Un code HTML mal formaté peut provoquer des erreurs d'exécution de JavaScript.
Les deux instructions JavaScript suivantes produiront des résultats différents :
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
</head>
<body>
<p id="Demo">段落 1。</p>
<p id="demo">段落 2。</p>
<script>
// 只有段落 2 会被替换
document.getElementById("demo").innerHTML = "HELLO.";
</script>
</body>
</html>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 London.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.
section suivante