Kommentarer i HTML
Hvordan man skriver nyttige kommentarer, når man koder HTML.
Edited: 2020-07-01 10:36
I HTML har vi mulighed for at skrive kommentarer i vores kode. Det er dog sjældent, at der er et egentligt behov for at gøre det. Hvis man skriver en kommentar, så er det derfor vigtigt, at de rent faktisk beskriver noget, som ikke fremgår af koden selv.
En kommentar der bare siger "footer" er helt overflødig, da samme information kan uddrages fra elementet <footer> alene. Ret ofte vil kommentarer i JavaScript også være overflødig, men det kan være nyttigt i enkelte tilfælde. Hvis eksempelvis ens script er meget komplekst, eller hvis man forklare hvordan en funktion interagere/afhænger af HTML-delen af en side.
En kommentar kan skrives ved at bruge mindre end (<) og større end (>), som vist her:
<!DOCTYPE html>
<html lang="da">
<head>
<!--Dette er en kommentar-->
<title>Min første hjemmeside</title>
</head>
<body>
<article>
<h1>Min første hjemmeside.</h1>
<p>Eksempel på hvordan man skriver en kommentar i HTML</p>
<!--Dette er endnu en kommentar-->
</article>
</body>
</html>
Hvornår kommentarer er nyttige
Kommentarer er mest nyttige, når de tilføjer information, som ellers ikke er tilgængelig i HTML koden. Det kan også være, at noget kode er tilstrækkeligt komplekst til, at en kommentar vil gøre det nemmere at forstå for andre, som måtte arbejde på koden. Dog er HTML normalt meget simpelt at forstå, og derfor kan kommentarer ligefrem have en modsat effekt. Det sker fordi de trods alt tager plads i koden, og derved kan gøre det svært, at overskue hvad man arbejder med.
Hvis man har anvendt en bestemt metode, til at inkludere eksternt indhold, så kan det nogle gange være en god idé at skrive en kommentar i koden. Eksempelvis hvis man indsætter video på en eksotisk måde, eller hvis man har brugt CSS tricks, som kan være svære at gennemskue uden ekspert viden.
Nogle gange vil man, imens man udvikler, udkommentere kode i en fil midlertidigt. Det kunne eksempelvis indgå i en fejlfindings proces.
kommentarernes placering
I reglen kan man, stort set, placere kommentarer alle steder i ens HTML, med enkelte undtagelser. Eksempelvis bør man undgå at placere en kommentar før <!doctype html> deklarationen. Derudover må man heller ikke placere kommentarer i attributter, eller inden i HTML tags (imellem < og >).
<!doctype html> delen skal være placeret på første linje, og der må ikke være noget placeret inden (heller ikke linjeskift eller mellemrum). Det er god praksis. Årsagen til det er, at nogle gamle browsere ellers ikke vil opfatte deklarationen, og dermed vil browseren ikke vise siden i "standard mode".
Fortæl os hvad du tænker: