Conventions de code HTML(5)


Conventions de code HTML

De nombreux développeurs web connaissent très peu les conventions de code HTML.

De 2000 à 2010, de nombreux développeurs web sont passés de HTML à XHTML.

Les développeurs utilisant XHTML ont progressivement développé de meilleures conventions de codage HTML.

Pour HTML5, nous devrions établir de bonnes conventions de code. Voici plusieurs conventions suggérées.


Utilisez le bon type de document

La déclaration de type de document se trouve sur la première ligne du document HTML :

<!DOCTYPE html>

Si vous voulez utiliser des minuscules comme les autres balises, vous pouvez utiliser le code suivant :

<!doctype html>

Utilisez des noms d'éléments en minuscules

Les noms d'éléments HTML5 peuvent utiliser des lettres majuscules et minuscules.

Les lettres minuscules sont recommandées :

  • Mélanger les styles majuscules et minuscules est très mauvais.
  • Les développeurs utilisent généralement les minuscules (similaire à XHTML).
  • Le style en minuscules semble plus propre.
  • Les lettres minuscules sont faciles à écrire.

Non recommandé :

<SECTION>
  <p>Ceci est un paragraphe.</p>
</SECTION>

Très mauvais :

<Section>
  <p>Ceci est un paragraphe.</p>
</SECTION>

Recommandé :

<section>
  <p>Ceci est un paragraphe.</p>
</section>

Fermez tous les éléments HTML

En HTML5, vous n'avez pas à fermer tous les éléments (par exemple les éléments <p>), mais nous recommandons d'ajouter une balise fermante à chaque élément.

Non recommandé :

<section>
  <p>Ceci est un paragraphe.
  <p>Ceci est un paragraphe.
</section>

Recommandé :

<section>
  <p>Ceci est un paragraphe.</p>
  <p>Ceci est un paragraphe.</p>
</section>

Fermez les éléments HTML vides

En HTML5, les éléments HTML vides n'ont pas non plus à être fermés :

Nous pouvons l'écrire comme ceci :

<meta charset="utf-8">

Ou comme ceci :

<meta charset="utf-8" />

La barre oblique (/) est obligatoire en XHTML et XML.

Si vous vous attendez à ce qu'un logiciel XML utilise votre page, utiliser ce style est très bien.


Utilisez des noms d'attributs en minuscules

Les noms d'attributs HTML5 autorisent les lettres majuscules et minuscules.

Nous recommandons d'utiliser des noms d'attributs en minuscules :

  • Mélanger majuscules et minuscules en même temps est une très mauvaise habitude.
  • Les développeurs utilisent généralement les minuscules (similaire à XHTML).
  • Le style en minuscules semble plus propre.
  • Les lettres minuscules sont faciles à écrire.

Non recommandé :

<div CLASS="menu">

Recommandé :

<div class="menu">

Valeurs d'attributs

Les valeurs d'attributs HTML5 ne sont pas obligées d'utiliser des guillemets.

Nous recommandons d'utiliser des guillemets pour les valeurs d'attributs :

  • Si une valeur d'attribut contient des espaces, des guillemets sont nécessaires.
  • Les styles mixtes ne sont pas recommandés ; il est conseillé d'être cohérent.
  • L'utilisation de guillemets pour les valeurs d'attribut est plus facile à lire.

Dans l'exemple suivant, la valeur d'attribut contient des espaces et n'utilise pas de guillemets, donc cela ne fonctionnera pas :

<table class=table striped>

L'exemple suivant utilise des guillemets doubles, ce qui est correct :

<table class="table striped">

Attributs d'image

Les images utilisent généralement l'attributalt. Lorsque l'image ne peut pas être affichée, son texte alternatif peut être affiché à la place de l'image.

<img src="html5.gif" alt="HTML5">

Définir les dimensions d'une image peut réserver l'espace spécifié pendant le chargement et réduire le scintillement.

<img src="html5.gif" alt="HTML5" style="width:128px;height:128px">

Espaces et signes d'égalité

Des espaces peuvent être utilisés avant et après le signe égal.

<link rel = "stylesheet" href = "styles.css">

Mais nous recommandons d'utiliser moins d'espaces :

<link rel="stylesheet" href="styles.css">

Évitez les longues lignes de code

Avec les éditeurs HTML, faire défiler le code horizontalement est peu pratique.

Essayez de garder chaque ligne de code sous 80 caractères.


Lignes vides et indentation

N'ajoutez pas de lignes vides sans raison.

Ajoutez des lignes vides pour chaque bloc logique de code, ce qui facilite la lecture.

Pour l'indentation, utilisez deux espaces ; l'utilisation de TAB n'est pas recommandée.

N'utilisez pas de lignes vides ni d'indentation inutiles entre du code relativement court.

Lignes vides et indentation inutiles :

<body>

  <h1>Exemple</h1>

  <h2>HTML</h2>

  <p>
Exemple, ce que vous apprenez n'est pas seulement la technologie, mais aussi les rêves.
Exemple, ce que vous apprenez n'est pas seulement la technologie, mais aussi les rêves.
Exemple, ce que vous apprenez n'est pas seulement la technologie, mais aussi les rêves,
Exemple, ce que vous apprenez n'est pas seulement la technologie, mais aussi les rêves.
  </p>

</body>

Recommandé :

<body>

<h1>Exemple</h1>

<h2></h2>
<p>Exemple, ce que vous apprenez n'est pas seulement la technologie, mais aussi les rêves.
Exemple, ce que vous apprenez n'est pas seulement la technologie, mais aussi les rêves.
Exemple, ce que vous apprenez n'est pas seulement la technologie, mais aussi les rêves.
Exemple, ce que vous apprenez n'est pas seulement la technologie, mais aussi les rêves.</p>

</body>

Exemple de tableau :

<table>
  <tr>
    <th>Nom</th>
    <th>Description</th>
  </tr>
  <tr>
    <td>A</td>
    <td>Description de A</td>
  </tr>
  <tr>
    <td>B</td>
    <td>Description de B</td>
  </tr>
</table>

Exemple de liste :

<ol>
  <li>Londres</li>
  <li>Paris</li>
  <li>Tokyo</li>
</ol>

Omettre <html> et <body> ?

Dans le standard HTML5, les balises <html> et <body> peuvent être omises.

Le document HTML5 suivant est correct :

Exemple :

<!DOCTYPE html>
<head>
  <title>Titre de la page</title>
</head>

<h1>Ceci est un titre</h1>
<p>Ceci est un paragraphe.</p>

Essayez-le vous-même »

L'omission des balises <html> et <body> n'est pas recommandée.

L'élément <html> est l'élément racine du document, utilisé pour décrire la langue de la page :

<!DOCTYPE html>
<html lang="zh">

Déclarer la langue est pratique pour les lecteurs d'écran et les moteurs de recherche.

Omettre <html> ou <body> fera planter les logiciels DOM et XML.

Omettre <body> causera des erreurs dans les anciens navigateurs (IE9).


Omettre <head> ?

Dans le standard HTML5, la balise <head> peut être omise.

Par défaut, les navigateurs ajouteront le contenu avant <body> à un élément <head> par défaut.

Exemple

<!DOCTYPE html>
<html>
<title>Titre de la page</title>

<body>
  <h1>Ceci est un titre</h1>
  <p>Ceci est un paragraphe.</p>
</body>

</html>

Essayez-le vous-même »
Note Omettre la balise head n'est toujours pas recommandé pour le moment.

Métadonnées

En HTML5, l'élément <title> est requis ; le nom du titre décrit le thème de la page :

<title>Tutoriel d'exemple</title>

Le titre et la langue peuvent permettre aux moteurs de recherche de comprendre rapidement le thème de votre page :

<!DOCTYPE html>
<html lang="zh">
<head>
  <meta charset="UTF-8">
  <title>Tutoriel d'exemple</title>
</head>

Commentaires HTML

Les commentaires peuvent être écrits dans<!--et-->:

<!-- Ceci est un commentaire -->

Les commentaires plus longs peuvent être écrits dans<!--et-->avec des sauts de ligne :

<!--
Ceci est un commentaire plus long. Ceci est un commentaire plus long. Ceci est un commentaire plus long.
Ceci est un commentaire plus long. Ceci est un commentaire plus long. Ceci est un commentaire plus long.
-->

Indentez le premier caractère d’un commentaire long de deux espaces pour faciliter la lecture.


Feuilles de style

Utilisez une syntaxe concise pour les feuilles de style (l’attribut type n’est pas requis) :

<link rel="stylesheet" href="styles.css">

Les règles courtes peuvent s’écrire sur une seule ligne :

p.into {font-family: Verdana; font-size: 16em;}

Les règles longues peuvent s’écrire sur plusieurs lignes :

body {
  background-color: lightgrey;
  font-family: "Arial Black", Helvetica, sans-serif;
  font-size: 16em;
  color: black;
}
  • Placez l’accolade ouvrante sur la même ligne que le sélecteur.
  • Ajoutez un espace entre l'accolade ouvrante et le sélecteur.
  • Utilisez deux espaces pour l'indentation.
  • Ajoutez un espace entre le deux-points et la valeur de la propriété.
  • Utilisez un espace après les virgules et les symboles.
  • Utilisez un point-virgule à la fin de chaque propriété et valeur.
  • N'utilisez des guillemets que lorsque les valeurs d'attribut contiennent des espaces.
  • Placez l'accolade fermante sur une nouvelle ligne.
  • Chaque ligne ne doit pas dépasser 80 caractères.
Note Ajouter un espace après les virgules et les deux-points est une règle courante.

Chargement de JavaScript dans HTML

Utilisez une syntaxe concise pour charger des fichiers de script externes (l'attribut type n'est pas nécessaire) :

<script src="myscript.js">

Utilisation de JavaScript pour accéder aux éléments HTML

Un mauvais formatage HTML peut causer des erreurs d'exécution JavaScript.

Les deux instructions JavaScript suivantes produisent des résultats différents :

Exemple

var obj = getElementById("Demo")

var obj = getElementById("demo")

Essayez-le vous-même »

Essayez d'utiliser des conventions de nommage cohérentes pour JavaScript en HTML.

Reportez-vous aux conventions de code JavaScript。


Utilisez des noms de fichiers en minuscules

La plupart des serveurs web (Apache, Unix) sont sensibles à la casse : london.jpg ne peut pas être accédé en tant que London.jpg.

D'autres serveurs web (Microsoft, IIS) ne sont pas sensibles à la casse : london.jpg peut être accédé en tant que London.jpg ou london.jpg.

Vous devez conserver un style cohérent. Nous recommandons de toujours utiliser des noms de fichiers en minuscules.


Extensions de fichiers

Les extensions de fichier HTML peuvent être.html(ou.htm)。

L'extension de fichier CSS est.css 。

L'extension de fichier JavaScript est.js 。


Différence entre .htm et .html

Les fichiers d'extension .htm et .html sont essentiellement identiques. Les navigateurs et les serveurs web les traitent comme des fichiers HTML.

La différence est :

.htm était utilisé dans les premiers systèmes DOS, où les extensions de fichier étaient limitées à trois caractères.

Dans les systèmes Unix, il n'y a pas de limite particulière sur les extensions, donc .html est couramment utilisé.

Différence technique

Si une URL ne spécifie pas de nom de fichier (par exemple, http://www.example.com/css/), le serveur renvoie un nom de fichier par défaut. Les noms de fichier par défaut courants sont index.html, index.htm, default.html et default.htm.

Si le serveur est configuré avec uniquement "index.html" comme fichier par défaut, vous devez nommer le fichier "index.html", et non "index.htm".

Cependant, les serveurs autorisent généralement plusieurs fichiers par défaut, et vous pouvez configurer les noms de fichiers par défaut selon vos besoins.

Dans tous les cas, l'extension complète pour HTML est ".html".

Autres extensions