LU04a - HTML Styleguide

In der Webentwicklung spielt HTML eine zentrale Rolle bei der Strukturierung von Inhalten auf Webseiten. Wie bei jeder Programmiersprache ist es auch hier wichtig, einen konsistenten und effizienten Coding-Stil zu pflegen. In diesem Artikel werden wir einen einheitlichen Coding-Stil für HTML aufzeugen und gute und schlechte Beispiele für HTML-Code präsentieren.

Dateinamen in Kleinbuchstaben schreiben

Einige Webserver (Apache, Unix) unterscheiden bei Dateinamen zwischen Gross- und Kleinschreibung: Auf „london.jpg“ kann nicht als „London.jpg“ zugegriffen werden.

Andere Webserver (Microsoft, IIS) unterscheiden nicht zwischen Gross- und Kleinschreibung: auf „london.jpg“ kann als „London.jpg“ zugegriffen werden.

Wenn Sie eine Mischung aus Gross- und Kleinbuchstaben verwenden, müssen Sie sich dessen bewusst sein. Wenn Sie von einem Server, der Gross- und Kleinschreibung nicht beachtet, zu einem Server wechseln, der Gross- und Kleinschreibung beachtet, werden selbst kleine Fehler Ihre Applikation zerstören!

Um diese Probleme zu vermeiden, sollten Sie Dateinamen immer in Kleinbuchstaben schreiben!

Elementnamen in Kleinbuchstaben schreiben

HTML erlaubt die Mischung von Gross- und Kleinbuchstaben in Elementnamen.

Wir empfehlen jedoch, Elementnamen in Kleinbuchstaben zu verwenden, denn:

Good: 

<body>
<p>This is a paragraph.</p>
</body>

Bad: 

<BODY>
<P>This is a paragraph.</P>
</BODY>

Kleinbuchstaben für Attributnamen verwenden

HTML erlaubt die Mischung von Gross- und Kleinbuchstaben in Attributnamen.

Wir empfehlen jedoch die Verwendung von Attributnamen in Kleinbuchstaben, denn:

Good: 

<a href="https://www.w3schools.com/html/">Visit our HTML tutorial</a>

Bad: 

<a HREF="https://www.w3schools.com/html/">Visit our HTML tutorial</a>

Attributwerte immer in Hochkomma setzen

HTML erlaubt Attributwerte ohne Anführungszeichen (double quotes) oder Hochkomma (single quote).

Wir empfehlen jedoch, Attributwerte in Anführungszeichen zu setzen, denn:

Good: 

<table class="striped">

Bad: 

<table class=striped>

Very Bad: 

<table class=table striped>

Alle HTML-Elemente schliessen

In HTML müssen Sie nicht alle Elemente schliessen (zum Beispiel das <p>-Element).

Wir empfehlen jedoch dringend, alle HTML-Elemente zu schliessen, etwa so:

Good: 

<section>
  <p>This is a paragraph.</p>
  <p>This is a paragraph.</p>
</section>

Bad: 

<section>
  <p>This is a paragraph.
  <p>This is a paragraph.
</section>

alt, width und height für Bilder angeben

Geben Sie immer das alt-Attribut für Bilder an. Dieses Attribut ist wichtig, wenn das Bild aus irgendeinem Grund nicht angezeigt werden kann.

Geben Sie ausserdem immer die Breite width und Höhe height von Bildern an. Dies verringert das Flackern, da der Browser vor dem Laden Platz für das Bild reservieren kann.

Good: 

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

Bad: 

<img src="html5.gif">

Leerzeichen und Gleichheitszeichen

HTML erlaubt Leerzeichen um Gleichheitszeichen. Ein Text ohne Leerzeichen ist jedoch leichter zu lesen und gruppiert Einheiten besser zusammen.

Good: 

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

Bad: 

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

Vermeiden Sie lange Codezeilen

Wenn Sie einen HTML-Editor verwenden, ist es NICHT bequem, nach rechts und links zu scrollen, um den HTML-Code zu lesen.

Versuchen Sie, zu lange Codezeilen zu vermeiden.

Leerzeilen und Einrückungen

Fügen Sie keine Leerzeilen, Leerzeichen oder Einrückungen ohne Grund ein. Fügen Sie zur besseren Lesbarkeit Leerzeilen ein, um grosse oder logische Codeblöcke zu trennen. Fügen Sie zur besseren Lesbarkeit zwei Leerzeichen als Einrückung ein.

Hinweis: Webstorm ersetzt je nach Einstellung einen Tabulator automatisch mit Leerzeichen

Good: 

<body>
 
<h1>Famous Cities</h1>
 
<h2>Tokyo</h2>
<p>Tokyo is the capital of Japan, the center of the Greater Tokyo Area, and the most populous metropolitan area in the world.</p>
 
<h2>London</h2>
<p>London is the capital city of England. It is the most populous city in the United Kingdom.</p>
 
<h2>Paris</h2>
<p>Paris is the capital of France. The Paris area is one of the largest population centers in Europe.</p>
 
</body>

Bad: 

<body>
<h1>Famous Cities</h1>
<h2>Tokyo</h2><p>Tokyo is the capital of Japan, the center of the Greater Tokyo Area, and the most populous metropolitan area in the world.</p>
<h2>London</h2><p>London is the capital city of England. It is the most populous city in the United Kingdom.</p>
<h2>Paris</h2><p>Paris is the capital of France. The Paris area is one of the largest population centers in Europe.</p>
</body>

Good Table Example: 

<table>
  <tr>
    <th>Name</th>
    <th>Description</th>
  </tr>
  <tr>
    <td>A</td>
    <td>Description of A</td>
  </tr>
  <tr>
    <td>B</td>
    <td>Description of B</td>
  </tr>
</table>

Good List Example: 

<ul>
  <li>London</li>
  <li>Paris</li>
  <li>Tokyo</li>
</ul>

<title>-Element immer angeben

Das <title>-Element ist in HTML erforderlich.

Der Inhalt eines Seitentitels ist sehr wichtig für die Suchmaschinenoptimierung (SEO)! Der Seitentitel wird von den Algorithmen der Suchmaschinen verwendet, um die Reihenfolge bei der Auflistung der Seiten in den Suchergebnissen zu bestimmen.

Das <title>-Element: 

<title>HTML Style Guide and Coding Conventions</title>

HTML-Kommentare

Kurze Kommentare sollten in einer Zeile geschrieben werden, etwa so: 

<!-- This is a comment -->

Kommentare, die sich über mehr als eine Zeile erstrecken, sollten wie folgt geschrieben werden: 

<!--
  This is a long comment example. This is a long comment example.
  This is a long comment example. This is a long comment example.
-->

Lange Kommentare sind besser zu erkennen, wenn sie mit zwei Leerzeichen eingerückt sind.

, ,

Frei nach den Beispielen von w3school