Commentaar Javascript in HTML

Michael Zippo

Als u HTML-opmerkingen wilt schrijven, voegt u <--- en in! - - -> aan beide uiteinden van de opmerking. Van HTML-opmerkingen is bekend dat ze de HTML-code overzichtelijk houden en worden genegeerd door de browser.

Een van de belangrijkste aspecten van documentatiesoftware zijn geschreven opmerkingen over de code. Opmerkingen zijn de regels in computerprogramma`s die worden genegeerd door interpreters en compilers en die bedoeld zijn om door mensen te worden gelezen.

Door opmerkingen te schrijven, kunt u uw code leesbaarder maken en de inhoud van specifieke delen van een programma gemaakt. Als u bijvoorbeeld een lang programma schrijft, kunt u opmerkingen gebruiken om bepaalde functies of regels code bij te houden.

In deze tutorial zullen we onderzoeken hoe u opmerkingen in HTML kunt schrijven. We beginnen met te kijken waarom opmerkingen worden gebruikt bij het programmeren. Vervolgens zullen we kijken naar de twee belangrijkste soorten opmerkingen:. Opmerkingen van één regel en opmerkingen van meerdere regels

Waarom schrijven ontwikkelaars opmerkingen

In HTML worden opmerkingen genegeerd? door browsers en ze worden verwijderd wanneer de code wordt gecompileerd en verkleind. Dus waarom schrijven we recensies?

Opmerkingen zijn geschreven om door mensen gelezen te worden en om de code begrijpelijker te maken. Wanneer u aan een enkel project werkt, is het gemakkelijk om opmerkingen over te slaan, omdat u de enige bent die uw code leest. Als u echter aan een groot project werkt dat complexe code bevat, kunt u gemakkelijk het doel van uw code uit het oog verliezen.

Als u in een team werkt, kunnen andere mensen de code ook niet begrijpen U schreef. Als dit het geval is, moeten mensen je misschien volgen om het doel van een specifieke code te achterhalen of ze kunnen een regel code overslaan zonder te begrijpen wat het betekent en hoe het werkt.

opmerkingen bieden een aantal voordelen voor ontwikkelaars. Ten eerste, zoals we hebben besproken, maken opmerkingen uw code gemakkelijker te begrijpen. Als u commentaar op uw code schrijft, zullen u en anderen die de code hebben gelezen, het gemakkelijker vinden om bij te houden wat er op bepaalde punten in de code gebeurt

Ten tweede stellen opmerkingen ontwikkelaars in staat om hun redenering achter beslissingen over een programma uit te leggen. Dit kan handig zijn wanneer een programma niet meer functioneert en een bug moet worden verholpen, of wanneer een ontwikkelaar meer duidelijkheid nodig heeft over de reden waarom een bepaalde benadering is gebruikt om een probleem op te lossen. Opmerkingen kunnen ook helpen het ontwikkelingsproces te versnellen, omdat het voor u gemakkelijker is om uw code te begrijpen.

HTML-commentaar

Commentaar in HTML documenten zijn omgeven door speciale pijlen en zijn gescheiden van de rest van het programma. Opmerkingen worden niet weergegeven door de browser. Hier is de syntaxis voor een eenvoudige HTML-commentaartag:

Als onze webpagina open is, doet deze code n niet op onze webpagina verschijnen. In plaats daarvan verschijnt de code in onze broncode om te lezen.

Het bovenstaande voorbeeld is een opmerking van één regel , wat betekent dat de tekst maar op één regel verschijnt. Dit type opmerking is handig als uw opmerking kort is. Als u echter van plan bent een lange opmerking te schrijven, moet u een opmerking met meerdere regels gebruiken.

De syntaxis voor opmerkingen met meerdere regels is hetzelfde als voor opmerkingen met één regel, met als enige verschil dat de opmerking staat op een nieuwe boerderijlijn. Hier is de syntaxis voor een commentaartag met meerdere regels:

HTML-opmerkingen gebruiken

Nu u weet hoe u HTML-opmerkingen moet schrijven, vraagt u zich misschien af: wanneer moet ik opmerkingen toevoegen aan mijn gecodeerde berichten? Hoewel er geen strikte richtlijnen zijn over wanneer feedback moet worden gebruikt en elke ontwikkelaar en elk team zijn eigen voorkeuren heeft, zijn er een paar dingen die u in gedachten moet houden.

Over het algemeen moeten opmerkingen worden gebruikt:

Natuurlijk zijn er andere situaties waarin u opmerkingen aan uw code kunt toevoegen, maar dit zijn de meest voorkomende.

Bovendien kunt u ook HTML-opmerkingen voor commentaar op HTML-tagblokken. Hiermee kunt u een regel code in uw programma houden, maar de browser vertelt deze te negeren wanneer de HTML-webpagina wordt weergegeven.

Reactiecode buiten uw programma om is gebruikelijk bij het debuggen, omdat u bij het debuggen de oorzaak van een probleem moet vinden en een oplossing moet implementeren, en het kan handig zijn om een programma te vertellen de code te negeren zonder deze volledig uit het programma te verwijderen.Hier is een voorbeeld van HTML-opmerkingen om commentaar te geven op code:

is een voorbeeldparagraaf.

Dit is een ander voorbeeld, alinea.

--->

Als onze browser deze code weergeeft, wordt de tweede alinea genegeerd omdat deze is opgenomen in de opmerkingen.

HTML-opmerkingen zijn weliswaar nuttig, maar mogen alleen worden gebruikt als ze waarde toevoegen aan het programma. Het is niet nodig om commentaar toe te voegen om alle functies van een programma uit te leggen of om de argumenten op een zinvolle manier uit te leggen. Hier zijn een paar tips die u in gedachten moet houden bij het schrijven van HTML-opmerkingen:

Conclusie

Het gebruik van opmerkingen HTML helpt bij het maken van uw herinnering prog beter leesbaar voor zowel u als voor andere mensen die uw code zouden lezen. Door opmerkingen in uw code te schrijven, kunnen anderen de bedoeling achter uw code gemakkelijker begrijpen.

In deze zelfstudie hebben we de basisprincipes van opmerkingen en hoe u een opmerking in HTML kunt maken. We hebben ook besproken waarom opmerkingen nuttig zijn, en we hebben best practices onderzocht voor het effectief schrijven van opmerkingen. Dat gezegd hebbende, heeft elke ontwikkelaar zijn eigen stijl van reageren en terwijl u andere opmerkingen schrijft, zult u die je zelf overneemt.