Richtig kommentiert HTML Markup ist ein wichtiger Bestandteil einer gut aufgebauten Webseite. Diese Kommentare sind einfach hinzuzufügen, und jeder, der in Zukunft am Code dieser Site arbeiten muss (einschließlich Sie selbst oder Mitglieder eines Teams, mit dem Sie zusammenarbeiten), wird Ihnen für diese Kommentare danken.
So fügen Sie HTML-Kommentare hinzu
HTML kann mit einem Standard-Texteditor wie Notepad++ für Windows oder TextEdit für einen Mac erstellt werden. Sie können auch ein webdesignorientiertes 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, wenn Sie direkt mit dem Code arbeiten, fügen Sie HTML-Kommentare wie folgt hinzu:
Fügen Sie den ersten Teil des HTML-Kommentar-Tags hinzu:
Schreiben Sie nach diesem einleitenden Teil des Kommentars den Text, der für diesen Kommentar erscheinen soll. Dies ist wahrscheinlich eine Anleitung für Ihren oder einen anderen Entwickler in der Zukunft. Wenn Sie beispielsweise angeben möchten, wo ein bestimmter Abschnitt auf einer Seite im Markup beginnt oder endet, können Sie dies mithilfe eines Kommentars näher erläutern.
Sobald der Text Ihres Kommentars vollständig ist, schließen Sie das Kommentar-Tag wie folgt:
Insgesamt sieht Ihr Kommentar also etwa so aus:
Es ist wirklich so einfach.
Die Anzeige von Kommentaren
Alle Kommentare, die Sie Ihrem HTML-Code hinzufügen, werden in diesem Code angezeigt, wenn jemand zeigt die Quelle der Webseite an oder öffnet den HTML-Code in einem Editor, um einige Änderungen vorzunehmen. Dieser Kommentartext wird jedoch nicht im Webbrowser angezeigt, wenn normale Besucher die Site besuchen. 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 "auszuschalten". Wenn Sie den einleitenden Teil eines Kommentars direkt vor dem Teil Ihrer Seite/des Codes einfügen, den Sie ausblenden möchten, und dann die schließender Teil am Ende dieses Codes (HTML-Kommentare können sich über mehrere Zeilen erstrecken, sodass Sie beispielsweise in Zeile 50 Ihres Codes einen Kommentar öffnen können und schließen Sie es ohne Probleme in Zeile 75), dann werden alle HTML-Elemente, die in diesen Kommentar fallen, nicht mehr in der angezeigt Browser. Sie verbleiben in Ihrem Code, wirken sich jedoch nicht auf die visuelle Darstellung der Seite aus. Wenn Sie eine Seite testen müssen, um zu sehen, ob ein bestimmter Abschnitt Probleme verursacht usw., ist es vorzuziehen, diesen Bereich auszukommentieren, anstatt ihn zu löschen. Wenn sich bei Kommentaren herausstellt, dass der betreffende Codeabschnitt nicht das Problem ist, können Sie die Kommentarteile einfach entfernen und dieser Code wird erneut angezeigt. Stellen Sie nur sicher, dass diese Kommentare, die zum Testen verwendet werden, es nicht auf Produktionswebsites schaffen. Wenn ein Bereich einer Seite nicht angezeigt werden soll, möchten Sie den Code entfernen und nicht nur auskommentieren, bevor Sie diese Site starten.
Eine großartige Verwendung von HTML-Kommentaren während der Entwicklung ist beim Erstellen you eine responsive Website. Weil verschiedene Teile dieser Site ihr Aussehen basierend auf ändern werden verschiedene Bildschirmgrößen, einschließlich einiger Bereiche, die möglicherweise überhaupt nicht angezeigt werden, kann die Verwendung von Kommentaren zum Ein- oder Ausschalten von Abschnitten einer Seite ein schneller und einfacher Trick während der Entwicklung sein.
Zur Leistung
Ich habe gesehen, wie einige Webprofis vorgeschlagen haben, Kommentare aus HTML- und CSS-Dateien zu entfernen, um die Größe dieser Dateien zu reduzieren und schneller ladende Seiten zu erstellen. Ich stimme zwar zu, dass Seiten sein sollten leistungsoptimiert und schnell geladen werden soll, gibt es noch einen Platz für die intelligente Verwendung von Kommentaren im Code. Denken Sie daran, diese Kommentare sollen Ihnen die Arbeit an einer Site in Zukunft erleichtern, solange Sie es nicht übertreiben Kommentare, die zu jeder Zeile in Ihrem Code hinzugefügt werden, sollte die kleine Dateigröße, die einer Seite aufgrund von Kommentaren hinzugefügt wird, größer als. sein akzeptabel.
Tipps zur Verwendung von Kommentaren
Einige Dinge, die Sie bei der Verwendung von HTML-Kommentaren beachten oder beachten sollten:
- 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 immer Sie möchten.
- Kommentare, die Bereiche einer Site "deaktivieren", sollten nicht in die Produktion aufgenommen werden, es sei denn, diese Änderung ist a vorübergehende, die in kurzer Zeit rückgängig gemacht wird (z. B. eine Warnmeldung ein- oder ausschalten, wenn erforderlich).