Correct commentaar HTML markup is een belangrijk onderdeel van een goed gebouwde webpagina. Die opmerkingen zijn gemakkelijk toe te voegen en iedereen die in de toekomst aan de code van die site moet werken (inclusief uzelf of leden van een team waarmee u werkt) zal u bedanken voor die 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 webdesign 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:
Voeg het eerste deel van de HTML-opmerkingstag toe:
Schrijf na dat openingsgedeelte van de opmerking de tekst die u voor deze opmerking wilt weergeven. Dit zijn in de toekomst waarschijnlijk instructies voor uw of een andere ontwikkelaar. Als u bijvoorbeeld wilt aangeven waar een bepaalde sectie op een pagina begint of eindigt in de opmaak, kunt u een opmerking gebruiken om dat te specificeren.
Zodra de tekst van uw opmerking compleet is, sluit u de opmerkingstag als volgt:
Dus in totaal ziet uw opmerking er ongeveer zo uit:
Het is echt zo simpel.
De weergave van opmerkingen
Alle opmerkingen die u aan uw HTML-code toevoegt, verschijnen in die code wanneer iemand bekijkt de bron van de webpagina of opent de HTML in een editor om enkele wijzigingen aan te brengen. Die commentaartekst verschijnt echter niet in de webbrowser wanneer normale bezoekers naar de site komen. In tegenstelling tot andere HTML-elementen, inclusief alinea's, koppen of lijsten, die daadwerkelijk van invloed zijn op de pagina in die browsers, zijn opmerkingen echt "achter de schermen" stukjes van de pagina.
Opmerkingen voor testdoeleinden
Omdat opmerkingen niet in een webbrowser verschijnen, kunnen ze worden gebruikt om delen van een pagina uit te schakelen tijdens het testen of ontwikkelen van pagina's. Als je het openingsgedeelte van een opmerking direct voor het gedeelte van je pagina/code dat je wilt verbergen toevoegt, en dan voeg je de sluitgedeelte aan het einde van die code (HTML-opmerkingen kunnen meerdere regels beslaan, dus u kunt een opmerking openen op bijvoorbeeld regel 50 van uw code en sluit het zonder problemen op regel 75), dan worden alle HTML-elementen die binnen die opmerking vallen niet langer weergegeven in de browser. Ze blijven in uw code, maar hebben geen invloed op de visuele weergave van de pagina. Als u een pagina moet testen om te zien of een bepaalde sectie problemen veroorzaakt, enz., verdient het de voorkeur om commentaar op dat gebied te geven boven het verwijderen ervan. Bij opmerkingen, als het gedeelte van de code in kwestie niet het probleem blijkt te zijn, kunt u de commentaarstukken eenvoudig verwijderen en wordt die code opnieuw weergegeven. Zorg er wel voor dat deze opmerkingen die voor het testen worden gebruikt, niet op productiewebsites terechtkomen. Als een gedeelte van een pagina niet moet worden weergegeven, wilt u de code verwijderen, niet alleen commentaar geven, voordat u die site start.
Een geweldig gebruik van HTML-opmerkingen tijdens de ontwikkeling is tijdens het bouwen een responsieve website. Omdat verschillende delen van die site hun uiterlijk zullen veranderen op basis van: verschillende schermformaten, inclusief 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.
Met betrekking tot prestaties
Ik heb gezien dat sommige webprofessionals suggereren dat opmerkingen uit HTML- en CSS-bestanden moeten worden verwijderd om de grootte van die bestanden te verkleinen en sneller ladende pagina's te creëren. Hoewel ik het ermee eens ben dat pagina's moeten zijn geoptimaliseerd voor prestaties en snel moeten laden, is er nog plaats voor slim gebruik van opmerkingen in code. Onthoud dat deze opmerkingen bedoeld zijn om het in de toekomst gemakkelijker te maken om aan een site te werken, dus zolang u niet overdrijft met opmerkingen toegevoegd aan elke regel in uw code, de kleine hoeveelheid bestandsgrootte die aan een pagina is toegevoegd vanwege opmerkingen, zou meer moeten zijn dan aanvaardbaar.
Tips voor het gebruik van opmerkingen
Een paar dingen om op te letten of te onthouden bij het gebruik van HTML-opmerkingen:
- Opmerkingen kunnen uit meerdere regels bestaan.
- Gebruik opmerkingen om de ontwikkeling van uw pagina te documenteren.
- Opmerkingen kunnen ook inhoud, tabelrijen of -kolommen documenteren, wijzigingen bijhouden of wat u maar wilt.
- Opmerkingen die delen van een site "uitzetten" mogen niet in productie worden genomen, tenzij deze wijziging een tijdelijke die in korte tijd wordt teruggedraaid (zoals een waarschuwingsbericht in- of uitschakelen als nodig zijn).