Skip to main content

Hoe en waarom opmerkingen toevoegen aan uw HTML

commentaarregels in je html code (April 2025)

commentaarregels in je html code (April 2025)
Anonim

Juiste commentaar HTML-opmaak is een belangrijk onderdeel van een goed gebouwde webpagina. Deze opmerkingen kunnen eenvoudig worden toegevoegd en iedereen die in de toekomst aan de code van die site moet werken (inclusief uzelf of leden van een team waarmee u werkt), bedankt u voor deze opmerkingen.

HTML-opmerkingen toevoegen

HTML kan worden geschreven met een standaard teksteditor, zoals Notepad ++ voor Windows of TextEdit voor een Mac. U kunt ook een op een webontwerp gericht programma zoals Adobe Dreamweaver of zelfs een CMS-platform zoals Wordpress of ExpressionEngine gebruiken. Ongeacht de tool die u gebruikt om HTML te schrijven, als u rechtstreeks met de code werkt, zou u HTML-opmerkingen als volgt toevoegen:

  1. Voeg het eerste deel van de HTML-commentaartag toe:

  2. Dus in totaal zal je reactie er ongeveer zo uitzien:

  3. Het is echt zo simpel.

De weergave van opmerkingen

Alle opmerkingen die u aan uw HTML-code toevoegt, worden in die code weergegeven wanneer iemand de bron van de webpagina bekijkt of de HTML in een editor opent om een ​​aantal wijzigingen aan te brengen. Die commentaartekst verschijnt echter niet in de webbrowser wanneer een normale bezoeker naar de site komt. In tegenstelling tot andere HTML-elementen, inclusief alinea's, kopjes of lijsten, die daadwerkelijk van invloed zijn op de pagina in die browsers, zijn opmerkingen echt 'achter de schermen'-delen van de pagina.

Opmerkingen voor testdoeleinden

Omdat opmerkingen niet in een webbrowser worden weergegeven, kunnen ze tijdens het testen of ontwikkelen van een pagina worden gebruikt om delen van een pagina 'uit te schakelen'. Als u het openingsgedeelte van een opmerking direct vóór het gedeelte van uw pagina / code dat u wilt verbergen toevoegt, voegt u het afsluitende gedeelte aan het einde van die code toe (HTML-opmerkingen kunnen meerdere regels omspannen, zodat u een reageer op regel 50 van uw code en sluit deze op regel 75 zonder problemen), dan worden alle HTML-elementen die binnen die opmerking vallen niet langer in de browser weergegeven. Ze blijven in uw code staan, maar hebben geen invloed op de visuele weergave van de pagina. Als u een pagina wilt testen om te zien of een bepaald gedeelte problemen veroorzaakt, enz., Verdient het de voorkeur om dat gedeelte uit te delen en het te verwijderen. Met opmerkingen, als het betreffende gedeelte van de code niet het probleem blijkt te zijn, kunt u eenvoudig de opmerkingen verwijderen en die code wordt opnieuw weergegeven. Zorg er wel voor dat deze opmerkingen die worden gebruikt voor het testen niet in productie-websites vallen.

Als een gedeelte van een pagina niet moet worden weergegeven, wilt u de code verwijderen en niet alleen maar een opmerking maken voordat u die site start.

Een groot gebruik van HTML-opmerkingen tijdens de ontwikkeling is wanneer u een responsieve website bouwt. Omdat verschillende delen van die site hun uiterlijk wijzigen op basis van verschillende schermformaten, waaronder sommige gebieden die mogelijk helemaal niet worden weergegeven, kan het gebruik van opmerkingen om secties van een pagina in of uit te schakelen een snelle en gemakkelijke truc zijn om te gebruiken tijdens de ontwikkeling.

Betreffende prestaties

Ik heb gezien dat sommige webprofessionals suggereren dat opmerkingen moeten worden ontdaan van HTML- en CSS-bestanden om de grootte van die bestanden te verkleinen en sneller ladende pagina's te maken. Hoewel ik het ermee eens ben dat pagina's moeten worden geoptimaliseerd voor prestaties en snel moeten laden, is er nog steeds ruimte voor slim gebruik van opmerkingen in code. Houd er rekening mee dat deze opmerkingen bedoeld zijn om het gemakkelijker te maken om in de toekomst op een site te werken, dus zolang u deze niet overlaadt met opmerkingen die aan elke regel in uw code zijn toegevoegd, is de kleine hoeveelheid bestandsgrootte die aan een pagina is toegevoegd vanwege opmerkingen moeten meer dan acceptabel zijn.

Tips voor het gebruik van opmerkingen

Een paar dingen om rekening mee te houden of onthouden bij het gebruik van HTML-opmerkingen:

  • Opmerkingen kunnen meerdere regels zijn.
  • Gebruik opmerkingen om de ontwikkeling van uw pagina te documenteren.
  • Opmerkingen kunnen ook inhoud, tabelrijen of -kolommen documenteren, veranderingen bijhouden of wat u maar wilt.
  • Opmerkingen die delen van een site "uitschakelen", mogen niet in productie worden genomen, tenzij deze wijziging tijdelijk is en in korte volgorde wordt omgekeerd (zoals wanneer een waarschuwingsbericht is in- of uitgeschakeld, indien nodig).