Korrekt kommenterad HTML-markup är en viktig del av en välbyggd webbsida. Dessa kommentarer är enkla att lägga till, och alla som behöver arbeta på den webbplatsens kod i framtiden (inklusive dig själv eller medlemmar i något lag du arbetar med) tackar dig för de här kommentarerna.
Så här lägger du till HTML-kommentarer
HTML kan vara författad med en vanlig textredigerare, som Notepad ++ for Windows eller TextEdit för en Mac. Du kan också använda ett webbdesign-centrerat program som Adobe Dreamweaver eller till och med en CMS-plattform som Wordpress eller ExpressionEngine. Oberoende av verktyget som du använder för författare HTML, om du arbetar direkt med koden, lägger du till HTML-kommentarer så här:
-
Lägg till den första delen av HTML-kommentarkoden:
-
Så totalt sett kommer din kommentar att se ut så här:
-
Det är verkligen så enkelt.
Visningen av kommentarer
Eventuella kommentarer som du lägger till i HTML-koden visas i den koden när någon visar källan till webbsidan eller öppnar HTML-koden i en redigerare för att göra några ändringar. Kommentarteksten kommer emellertid inte att visas i webbläsaren när en vanlig besökare kommer till webbplatsen. Till skillnad från andra HTML-element, inklusive stycken, rubriker eller listor, som faktiskt påverkar sidan i dessa webbläsare, är kommentarer verkligen "bakom kulisserna" av sidan.
Kommentarer för teständamål
Eftersom kommentarer inte visas i en webbläsare kan de användas för att "stänga av" delar av en sida under sidtestning eller utveckling. Om du lägger till den inledande delen av en kommentar direkt före den del av din sida / kod som du vill gömma, lägger du till den sista delen i slutet av den koden (HTML-kommentarer kan spänna över flera rader, så att du kan öppna en kommentera säg linje 50 i koden och stäng den på rad 75 utan problem), då kommer inte alla HTML-element som ingår i den kommentaren att visas i webbläsaren. De kommer att förbli i din kod, men kommer inte att påverka sidans visuella visning. Om du behöver testa en sida för att se om en viss sektion orsakar problem etc., är det lämpligt att kommentera det här området för att radera det. Med kommentarer, om den aktuella sektionskoden inte är problemet, kan du enkelt ta bort kommentarbitarna och den här koden visas igen. Var bara säker på att dessa kommentarer som används för testning inte gör det till produktionswebbplatser.
Om ett område på en sida inte ska visas, vill du ta bort koden, inte bara kommentera den, innan du startar den där sidan.
En stor användning av HTML-kommentarer under utveckling är när du bygger en lyhörd webbplats. Eftersom olika delar av den här webbplatsen kommer att ändra sitt utseende baserat på olika skärmstorlekar, inklusive vissa områden som kanske inte visas alls, kan du använda ett snabbt och enkelt trick att använda kommentarer för att växla sektioner på en sida på sidan under utveckling.
När det gäller prestanda
Jag har sett några webbprofessorer föreslår att kommentarer ska avlägsnas från HTML- och CSS-filer för att raka ner storleken på dessa filer och skapa snabbare sidor. Medan jag håller med om att sidor ska optimeras för prestanda och bör laddas snabbt, finns det fortfarande plats för smart användning av kommentarer i koden. Kom ihåg att dessa kommentarer är avsedda att göra det enklare att arbeta på en webbplats i framtiden, så länge du inte försenar det med kommentarer som läggs till i varje rad i din kod, läggs den lilla filstorleken till en sida på grund av kommentarer ska vara mer än acceptabla.
Tips för att använda kommentarer
Några saker att tänka på eller komma ihåg när du använder HTML-kommentarer:
- Kommentarer kan vara flera linjer.
- Använd kommentarer för att dokumentera din sidas utveckling.
- Kommentarer kan också dokumentera innehåll, tabellrader eller kolumner, spåra ändringar eller vad du vill.
- Kommentarer om att "avaktivera" områden på en webbplats ska inte göra det till produktion om inte denna ändring är en tillfällig som kommer att vändas i kort ordning (som att ha ett varningsmeddelande aktiverat eller avstängt efter behov).
