Das ordnungsgemäß kommentierte HTML-Markup ist ein wichtiger Bestandteil einer gut aufgebauten Webseite. Diese Kommentare sind leicht hinzuzufügen und jeder, der in Zukunft mit dem Code dieser Website arbeiten muss (einschließlich sich selbst oder Mitglieder eines Teams, mit dem Sie zusammenarbeiten), wird sich für diese Kommentare bedanken.
So fügen Sie HTML-Kommentare hinzu
HTML kann mit einem Standard-Texteditor erstellt werden, z. B. Notepad ++ für Windows oder TextEdit für einen Mac. Sie können auch ein Webdesign-orientiertes Programm wie Adobe Dreamweaver oder sogar eine CMS-Plattform wie Wordpress oder ExpressionEngine verwenden. Unabhängig von dem Tool, das Sie zum Erstellen von HTML verwenden, würden Sie, wenn Sie direkt mit dem Code arbeiten, HTML-Kommentare wie folgt hinzufügen:
-
Fügen Sie den ersten Teil des HTML-Kommentar-Tags hinzu:
-
Insgesamt sieht dein Kommentar also etwa so aus:
-
Es ist wirklich so einfach.
Die Anzeige von Kommentaren
Alle Kommentare, die Sie zu Ihrem HTML-Code hinzufügen, werden in diesem Code angezeigt, wenn jemand den Quellcode der Webseite anzeigt oder den HTML-Code in einem Editor öffnet, um Änderungen vorzunehmen. Dieser Kommentartext wird jedoch nicht im Webbrowser angezeigt, wenn ein normaler Besucher auf die Website kommt. Im Gegensatz zu anderen HTML-Elementen, einschließlich Absätzen, Überschriften oder Listen, die sich tatsächlich auf die Seite in diesen Browsern auswirken, sind Kommentare wirklich "hinter den Kulissen" der Seite.
Kommentare zu Testzwecken
Da Kommentare nicht in einem Webbrowser angezeigt werden, können sie verwendet werden, um Teile einer Seite während des Seitentests oder der Entwicklung zu deaktivieren. Wenn Sie den Anfangsteil eines Kommentars direkt vor dem Teil Ihrer Seite / Ihres Codes hinzufügen, den Sie ausblenden möchten, und dann den schließenden Teil am Ende dieses Codes hinzufügen (HTML-Kommentare können sich über mehrere Zeilen erstrecken, sodass Sie einen öffnen können kommentieren Sie z. B. Zeile 50 Ihres Codes und schließen Sie ihn in Zeile 75 ohne Probleme.) Die HTML-Elemente, die in diesen Kommentar fallen, werden dann nicht mehr im Browser angezeigt. Sie verbleiben in Ihrem Code, haben jedoch keinen Einfluss auf die visuelle Anzeige der Seite. Wenn Sie eine Seite testen müssen, um herauszufinden, ob ein bestimmter Abschnitt Probleme usw. verursacht, ist es besser, diesen Bereich zu kommentieren, als ihn zu löschen. Wenn sich der betreffende Codeabschnitt als nicht problematisch erweist, können Sie die Kommentarteile mit Kommentaren leicht entfernen, und der Code wird erneut angezeigt. Stellen Sie nur sicher, dass diese Kommentare, die zum Testen verwendet werden, nicht in die Produktionswebseiten gelangen.
Wenn ein Bereich einer Seite nicht angezeigt werden soll, möchten Sie den Code entfernen und nicht nur auskommentieren, bevor Sie die Site starten.
HTML-Kommentare werden während der Entwicklung besonders verwendet, wenn Sie eine responsive Website erstellen. Da verschiedene Teile dieser Website ihr Erscheinungsbild basierend auf unterschiedlichen Bildschirmgrößen ändern, einschließlich einiger Bereiche, die möglicherweise überhaupt nicht angezeigt werden, kann die Verwendung von Kommentaren zum Ein- und Ausschalten von Abschnitten einer Seite während der Entwicklung ein schneller und einfacher Trick sein.
In Bezug auf Leistung
Ich habe gesehen, dass einige Web-Experten angaben, dass Kommentare aus HTML- und CSS-Dateien entfernt werden sollten, um die Größe dieser Dateien zu reduzieren und Seiten mit schnellerem Laden zu erstellen. Ich stimme zu, dass Seiten für die Leistung optimiert werden sollten und schnell geladen werden sollten, aber es gibt immer noch Platz für die intelligente Verwendung von Kommentaren im Code. Denken Sie daran, dass diese Kommentare die Arbeit an einer Website in Zukunft erleichtern sollen. Solange Sie sie nicht mit Kommentaren zu jeder Zeile in Ihrem Code überfordern, ist die geringe Dateigröße, die zu einer Seite hinzugefügt wird Kommentare sollten mehr als akzeptabel sein.
Tipps zur Verwendung von Kommentaren
Einige Dinge, die Sie beachten sollten, wenn Sie HTML-Kommentare verwenden:
- Kommentare können aus mehreren Zeilen bestehen.
- Verwenden Sie Kommentare, um die Entwicklung Ihrer Seite zu dokumentieren.
- Kommentare können auch Inhalte, Tabellenzeilen oder -spalten dokumentieren, Änderungen nachverfolgen oder was auch immer Sie möchten.
- Kommentare, die Bereiche einer Site "ausschalten", sollten nicht in die Produktion aufgenommen werden, es sei denn, diese Änderung ist eine temporäre Änderung, die kurzfristig rückgängig gemacht wird (z. B. wenn eine Warnmeldung nach Bedarf aktiviert oder deaktiviert wird).
