Wanneer u een webpagina in een browser bekijkt, ziet u een visuele weergave van wat dat stukje software (de webbrowser) weergeeft op basis van de code van een bepaalde webpagina. Als u die broncode van de webpagina bekijkt, ziet u een document dat bestaat uit verschillende HTML-elementen, inclusief alinea's, kopjes, lijsten, koppelingen, afbeeldingen en meer. Al deze elementen worden door de browser weergegeven op een bezoekersscherm als onderdeel van de weergave van de website. Een ding dat u misschien in HTML-code vindt die niet op het scherm van een persoon wordt weergegeven, is wat bekend staat als "HTML-opmerkingen".
Wat is een reactie?
Een opmerking is een reeks code in HTML, XML of CSS die niet wordt bekeken of waarnaar wordt gehandeld door de browser of parser. Het wordt eenvoudig in de code geschreven om informatie over die code of andere feedback van de codeontwikkelaars te verschaffen.
De meeste programmeertalen hebben opmerkingen; ze worden vaak gebruikt door de ontwikkelaar van de code voor één of zelfs meer dan één van de volgende redenen:
- Beschrijf en vertel ingewikkelde code aan iemand die er misschien in de toekomst aan moet werken - inclusief zichzelf! Ze komen misschien terug naar code 3 of 6 van 12 maanden of later en kunnen zich niet herinneren waarom ze iets op een bepaalde manier hebben gedaan. Reacties kunnen helpen hun vragen te beantwoorden en hen eraan te herinneren waar hun geest was toen zij die pagina voor het eerst ontwikkelden.
- Geef details over wanneer de code is bewerkt of beoordeeld. Dit kan nuttige informatie zijn en enigszins werken als een ontwikkelingslogboek van wanneer een site het laatst werd bewerkt.
- Verwijder secties van de code, maar laat ze beschikbaar voor later gebruik. Dit wordt vaak gedaan tijdens het testen en debuggen van de site. Als u een probleem heeft op een site en niet zeker weet wat de oorzaak is, kunt u de secties een voor een een opmerking geven om het probleem in quarantaine te plaatsen en vervolgens een oplossing te zoeken voor alle problemen die u ondervindt.
- Chat met andere ontwikkelaars die aan de code werken. Dit zou waarschijnlijk tijdens de ontwikkeling worden gedaan als een manier om details te delen met anderen die tegelijkertijd aan de code werken. Als deze opmerkingen puur ontwikkelingsgesprekken zijn, is het een goede gewoonte om ze uit de code te verwijderen voordat een site wordt gestart.
Traditioneel worden opmerkingen in HTML voor bijna alle elementen gebruikt, van uitleg over complexe tabelstructuren tot informatieve opmerkingen over de inhoud van de pagina zelf. Aangezien opmerkingen niet in een browser worden weergegeven, kunt u ze overal in de HTML toevoegen en hoeft u zich geen zorgen te maken over wat het gaat doen wanneer de site door een klant wordt bekeken.
Hoe opmerkingen te schrijven
Reacties schrijven in HTML, XHTML en XML is heel eenvoudig. Omzeil eenvoudig de tekst die u als commentaar wilt plaatsen met het volgende:
en
Zoals u kunt zien, beginnen deze opmerkingen met een "minder dan symbool", plus een uitroepteken en twee streepjes. De reactie eindigt met nog twee streepjes en een "groter dan: symbool". Tussen deze karakters kun je schrijven wat je maar wilt in de kern van de opmerking.
In CSS is het een beetje anders, met behulp van C-code opmerkingen in plaats van HTML U begint met een schuine streep gevolgd door een asterisk. Je beëindigt de opmerking met het omgekeerde ervan, een sterretje gevolgd door een schuine streep.
Reacties zijn een stervende kunst
De meeste programmeurs weten de waarde van bruikbare opmerkingen. Met de code met opmerkingen wordt het eenvoudiger om die code van het ene teamlid naar het andere over te zetten. Opmerkingen helpen het QA-team om de code te testen, omdat ze kunnen vertellen wat de ontwikkelaar bedoelde, zelfs als dit niet werd bereikt. Helaas, met de populariteit van website-authoringplatforms zoals Wordpress, die je in staat stellen om aan de slag te gaan met een gekozen thema dat veel, zo niet alle HTML voor je verwerkt, worden reacties niet zo vaak gebruikt door webteams. Dit komt omdat de opmerkingen erg moeilijk te zien zijn in de meeste visuele authoringtools als je niet direct met de code werkt. Bijvoorbeeld, in plaats van te zien, bovenaan een webpagina:
De visuele tool toont een klein pictogram om aan te geven dat er een opmerking is. Als de ontwerper de opmerking niet fysiek opent, ziet hij deze waarschijnlijk nooit. En in het geval van de bovenstaande pagina, kan dit problemen veroorzaken als ze de pagina bewerkt en dat bewerken wordt overschreven door het script dat in de opmerking wordt genoemd.
Wat gedaan kan worden?
- Schrijf zinvolle en nuttige opmerkingen. Verwacht niet van andere mensen dat ze uw opmerkingen lezen als ze te lang zijn of geen nuttige informatie bevatten.
- Als ontwikkelaar zou je dat moeten doen altijd bekijk alle opmerkingen die u op een pagina ziet.
- Gebruik de hulpprogramma's van de ontwerpprogramma's waarmee u opmerkingen kunt toevoegen.
- Gebruik inhoudsbeheer om te bepalen hoe de pagina's worden bewerkt.
Zelfs als u de enige persoon bent die uw webpagina's bewerkt, kunnen opmerkingen handig zijn. Als je maar één keer per jaar een gecompliceerde pagina bewerkt, vergeet je gemakkelijk hoe je de tabel hebt gebouwd of de CSS hebt samengesteld. Met opmerkingen hoeft u het niet te onthouden, omdat het hier precies voor u is geschreven.
