Kommentar Javascript In HTML

Michael Zippo 04.11.2021

Um HTML-Kommentare zu schreiben, fügen Sie <--- und ein! - - -> an beiden Enden des Kommentars. HTML-Kommentare sorgen dafür, dass HTML-Code organisiert bleibt, und werden vom Browser ignoriert.

Einer der wichtigsten Aspekte von Dokumentationssoftware sind geschriebene Kommentare zum Code. Kommentare sind Zeilen in Computerprogrammen, die von Interpretern und Compilern ignoriert werden und von Menschen gelesen werden sollen.

Durch das Schreiben von Kommentaren können Sie Ihren Code besser lesbar machen und den Inhalt bestimmter Teile angeben ein Programm gemacht. Wenn Sie beispielsweise ein langes Programm schreiben, können Sie Kommentare verwenden, um bestimmte Funktionen oder Codezeilen nachzuverfolgen.

In diesem Tutorial untersuchen wir, wie Kommentare in HTML geschrieben werden. Wir beginnen damit, uns anzusehen, warum Kommentare in der Programmierung verwendet werden. Als Nächstes sehen wir uns die zwei Haupttypen von Kommentaren an:. Einzeilige Kommentare und mehrzeilige Kommentare

Warum schreiben Entwickler Kommentare

In HTML werden Kommentare ignoriert? von Browsern und sie werden entfernt, wenn der Code kompiliert und minimiert wird. Warum schreiben wir Rezensionen?

Kommentare werden geschrieben, damit sie von Menschen gelesen werden können und den Code leichter verständlich machen. Wenn Sie an einem einzelnen Projekt arbeiten, ist es einfach, Kommentare zu überspringen, da Sie die einzige Person sind, die Ihren Code liest. Wenn Sie jedoch an einem großen Projekt mit komplexem Code arbeiten, können Sie leicht den Zweck Ihres Codes aus den Augen verlieren.

Auch wenn Sie in einem Team arbeiten, verstehen andere Personen den Code möglicherweise nicht Sie schrieben. Wenn dies der Fall ist, müssen die Leute Ihnen möglicherweise folgen, um den Zweck eines bestimmten Codes herauszufinden, oder sie überspringen möglicherweise eine Codezeile, ohne zu verstehen, was er bedeutet und wie er funktioniert.

Kommentare bieten eine Reihe von Vorteilen für Entwickler. Erstens machen Kommentare, wie wir besprochen haben, Ihren Code leichter verständlich. Wenn Sie Kommentare zu Ihrem Code schreiben, können Sie und andere, die den Code gelesen haben, leichter verfolgen, was an bestimmten Stellen im Code passiert

Zweitens ermöglichen Kommentare Entwicklern, ihre Gründe für Entscheidungen zu einem Programm zu erläutern . Dies kann nützlich sein, wenn ein Programm nicht mehr funktioniert und eine Fehlerbehebung erforderlich ist, oder wenn ein Entwickler mehr Klarheit über den Grund dafür benötigt ein bestimmter Ansatz wurde verwendet, um ein Problem zu lösen. Kommentare können auch dazu beitragen, den Entwicklungsprozess zu beschleunigen, da es für Sie einfacher ist, Ihren Code zu verstehen.

HTML-Kommentar

Kommentare in HTML Dokumente sind von speziellen Pfeilen umgeben und vom Rest des Programms getrennt. Kommentare werden vom Browser nicht angezeigt. Hier ist die Syntax für ein einfaches HTML-Kommentar-Tag:

Wenn unsere Webseite geöffnet ist, macht dieser Code n nicht auf unserer Webseite erscheinen. Stattdessen erscheint der Code in unserem Quellcode zum Lesen.

Das obige Beispiel ist ein einzeiliger Kommentar, was bedeutet, dass der Text nur in einer Zeile erscheint. Diese Art von Kommentar ist nützlich, wenn Ihr Kommentar kurz sein wird. Wenn Sie jedoch beabsichtigen, einen langen Kommentar zu schreiben, sollten Sie einen mehrzeiligen Kommentar verwenden.

Die Syntax für mehrzeilige Kommentare ist dieselbe wie für einzeilige Kommentare, mit dem einzigen Unterschied, dass der Kommentar ist auf einer neuen Farmlinie. Hier ist die Syntax für ein mehrzeiliges Kommentar-Tag:

Verwenden von HTML-Kommentaren

Jetzt, da Sie wissen, wie man HTML-Kommentare schreibt, fragen Sie sich vielleicht: Wann sollte ich Kommentare zu meinem Code hinzufügen? Obwohl es keine strengen Richtlinien für die Verwendung von Feedback gibt und jeder Entwickler und jedes Team seine eigenen Vorlieben hat, gibt es ein paar Dinge, die Sie beachten sollten.

Kommentare sollten im Allgemeinen verwendet werden:

Natürlich gibt es andere Situationen, in denen Sie Ihrem Code Kommentare hinzufügen können, aber dies sind die häufigsten.

Außerdem können Sie auch verwenden HTML-Kommentare zum Kommentieren von HTML-Tag-Blöcken. Dadurch können Sie eine Codezeile in Ihrem Programm belassen, aber den Browser anweisen, sie zu ignorieren, wenn die HTML-Webseite gerendert wird.

Kommentieren von Code außerhalb Ihres Programms ist beim Debuggen üblich, da Sie beim Debuggen die Ursache eines Problems finden und eine Lösung implementieren müssen, und es hilfreich sein kann, einem Programm mitzuteilen, dass es den Code ignorieren soll, ohne ihn vollständig aus dem Programm zu entfernen.Hier ist ein Beispiel der Verwendung von HTML-Kommentaren zum Kommentieren von Code:

ist ein Beispielabsatz.

Dies ist ein weiteres Beispiel, Absatz.

--->

Wenn unser Browser diesen Code darstellt, wird der zweite Absatz ignoriert, weil er ist in den Kommentaren enthalten.

HTML-Kommentare sind zwar nützlich, sollten aber nur verwendet werden, wenn sie einen Mehrwert für das Programm darstellen. Es müssen keine Kommentare hinzugefügt werden, um alle Funktionen eines Programms zu erklären oder die Argumente sinnvoll zu erklären. Hier sind ein paar Tipps, die Sie beim Schreiben von HTML-Kommentaren beachten sollten:

Fazit

Die Verwendung von Kommentar-HTML hilft bei der Erinnerung prog lesbarer sowohl für Sie als auch für andere Personen, die Ihren Code lesen würden. Das Schreiben von Kommentaren in Ihren Code kann es anderen erleichtern, die Absicht hinter Ihrem Code zu verstehen.

In diesem Tutorial haben wir die Grundlagen von Kommentaren und wie man einen Kommentar in HTML erstellt. Wir haben auch besprochen, warum Kommentare nützlich sind, und wir haben Best Practices für das effektive Schreiben von Kommentaren untersucht. Allerdings hat jeder Entwickler seinen eigenen Kommentarstil, und Sie werden feststellen, wie Sie andere Kommentare schreiben die Sie übernehmen.