Wenn Sie eine Webseite in einem Browser anzeigen, sehen Sie eine visuelle Darstellung dessen, was die Software (der Webbrowser) basierend auf dem Code einer bestimmten Webseite anzeigt. Wenn Sie den Quellcode der Webseite anzeigen, wird ein Dokument angezeigt, das aus verschiedenen HTML-Elementen besteht, einschließlich Absätzen, Überschriften, Listen, Links, Bildern und mehr. Alle diese Elemente werden vom Browser auf dem Bildschirm eines Besuchers als Teil der Anzeige der Website dargestellt. Was Sie in HTML-Code finden, der nicht auf dem Bildschirm einer Person dargestellt wird, sind die sogenannten "HTML-Kommentare".
Was ist ein Kommentar?
Ein Kommentar ist eine Zeichenfolge aus HTML, XML oder CSS, die vom Browser oder Parser nicht angezeigt oder bearbeitet wird. Es wird einfach in den Code geschrieben, um Informationen über diesen Code oder anderes Feedback von den Codeentwicklern bereitzustellen.
Die meisten Programmiersprachen enthalten Kommentare. Sie werden vom Entwickler des Codes aus einem oder mehreren Gründen aus folgendem Grund verwendet:
- Beschreibe und erkläre jemandem komplizierten Code, der möglicherweise in der Zukunft daran arbeiten muss - einschließlich sich selbst! Sie können zu Code 3 oder 6 von 12 Monaten oder später zurückkehren und sich nicht daran erinnern, warum sie etwas auf eine bestimmte Weise getan haben. Kommentare können helfen, ihre Fragen zu beantworten und sie daran zu erinnern, wo sich ihre Meinung befand, als sie diese Seite zum ersten Mal entwickelten.
- Geben Sie Details an, wann der Code bearbeitet oder überprüft wurde. Dies kann eine hilfreiche Information sein und ein bisschen wie ein Entwicklungsprotokoll darüber sein, wann eine Site zuletzt bearbeitet wurde.
- Entfernen Sie Abschnitte des Codes, aber lassen Sie sie für eine spätere Verwendung verfügbar. Dies wird häufig beim Testen und Debuggen von Sites durchgeführt. Wenn Sie ein Problem auf einer Website haben und nicht sicher sind, was die Ursache ist, können Sie die Abschnitte einzeln kommentieren, um das Problem zu isolieren und das Problem zu identifizieren. Anschließend können Sie eine Lösung für alle Ihre Probleme suchen.
- Chatten Sie mit anderen Entwicklern, die an dem Code arbeiten. Dies würde wahrscheinlich während der Entwicklung geschehen, um Details mit anderen Benutzern zu teilen, die gleichzeitig am Code arbeiten. Wenn es sich bei diesen Kommentaren um reine Entwicklungsgespräche handelt, empfiehlt es sich, sie vor dem Start einer Website aus dem Code zu entfernen.
Normalerweise werden Kommentare in HTML für fast alle Elemente verwendet, von Erklärungen zu komplexen Tabellenstrukturen bis hin zu informativen Anmerkungen zum Inhalt der Seite selbst. Da Kommentare nicht in einem Browser gerendert werden, können Sie sie an einer beliebigen Stelle im HTML-Code hinzufügen. Sie müssen sich keine Gedanken darüber machen, was sie tun wird, wenn die Website von einem Kunden angezeigt wird.
Wie schreibe ich Kommentare?
Das Schreiben von Kommentaren in HTML, XHTML und XML ist sehr einfach. Umschließen Sie den zu kommentierenden Text einfach mit folgendem:
und
Wie Sie sehen, beginnen diese Kommentare mit einem "weniger als Symbol", einem Ausrufezeichen und zwei Bindestrichen. Der Kommentar endet mit zwei weiteren Bindestrichen und einem "Größer als:". Zwischen diesen Zeichen können Sie schreiben, was Sie zum Hauptteil des Kommentars machen möchten.
In CSS ist dies etwas anders, wenn Sie C-Code-Kommentare anstelle von HTML verwenden. Sie beginnen mit einem Schrägstrich gefolgt von einem Sternchen. Sie beenden den Kommentar mit der Umkehrung davon, einem Sternchen gefolgt von einem Schrägstrich.
Kommentare sind eine sterbende Kunst
Die meisten Programmierer kennen den Wert nützlicher Kommentare. Kommentierter Code erleichtert die Übertragung dieses Codes von einem Teammitglied an ein anderes. Kommentare helfen Ihrem QA-Team, den Code zu testen, weil er erkennen kann, was der Entwickler beabsichtigt hat - auch wenn dies nicht erreicht wurde. Aufgrund der Beliebtheit von Website-Authoring-Plattformen wie Wordpress, die es Ihnen ermöglichen, ein ausgewähltes Design zu erstellen, das einen Großteil des HTML-Codes für Sie ausmacht, werden Kommentare von Web-Teams nicht so häufig verwendet. Dies liegt daran, dass die Kommentare in den meisten visuellen Authoring-Tools nur schwer zu sehen sind, wenn Sie nicht direkt mit dem Code arbeiten. Zum Beispiel, anstatt oben auf einer Webseite zu sehen:
Das visuelle Tool zeigt ein kleines Symbol an, das darauf hinweist, dass ein Kommentar vorhanden ist. Wenn der Designer den Kommentar nicht physisch öffnet, wird er ihn möglicherweise nie sehen. Und im Fall der obigen Seite kann es zu Problemen kommen, wenn sie die Seite bearbeitet und diese Bearbeitung durch das im Kommentar erwähnte Skript überschrieben wird.
Was kann gemacht werden?
- Schreiben Sie sinnvolle und nützliche Kommentare. Erwarten Sie nicht, dass andere Ihre Kommentare lesen, wenn sie zu lang sind oder keine hilfreichen Informationen enthalten.
- Als Entwickler sollten Sie dies tun immer Überprüfen Sie alle Kommentare, die Sie auf einer Seite sehen.
- Verwenden Sie die von den Authoring-Programmen bereitgestellten Tools, mit denen Sie Kommentare hinzufügen können.
- Mit der Inhaltsverwaltung können Sie steuern, wie die Seiten bearbeitet werden.
Auch wenn Sie die einzige Person sind, die Ihre Webseiten bearbeitet, können Kommentare hilfreich sein. Wenn Sie eine komplizierte Seite nur einmal pro Jahr bearbeiten, können Sie leicht vergessen, wie Sie die Tabelle erstellt oder das CSS zusammengestellt haben. Mit Kommentaren müssen Sie sich nicht daran erinnern, da es genau für Sie geschrieben wurde.
