Kommentarer ordentligt HTML markering är en viktig del av en välbyggd webbsida. Dessa kommentarer är enkla att lägga till, och alla som behöver arbeta med webbplatsens kod i framtiden (inklusive dig själv eller medlemmar i något team du arbetar med) kommer att tacka dig för dessa kommentarer.
Hur man lägger till HTML-kommentarer
HTML kan skapas med en standardtextredigerare, som Notepad ++ för Windows eller TextEdit för en Mac. Du kan också använda ett webbdesigncentrerat program som Adobe Dreamweaver eller till och med en CMS-plattform som Wordpress eller ExpressionEngine. Oavsett vilket verktyg du använder för att skapa HTML, skulle du lägga till HTML-kommentarer så här om du arbetar direkt med koden:
Lägg till den första delen av HTML-kommentarstaggen:
Efter den inledande delen av kommentaren, skriv vilken text du vill ska visas för den här kommentaren. Detta kommer sannolikt att vara instruktioner för din eller en annan utvecklare i framtiden. Om du till exempel vill ange var ett visst avsnitt på en sida börjar eller slutar i markeringen kan du använda en kommentar för att beskriva det.
När texten i din kommentar är klar stänger du kommentarstaggen så här:
Så totalt sett kommer din kommentar att se ut så här:
Det är verkligen så enkelt.
Visningen av kommentarer
Alla kommentarer som du lägger till i din HTML-kod kommer att 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. Den kommentartexten visas dock inte i webbläsaren när vanliga 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" delar 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 inledningsdelen av en kommentar direkt före den del av din sida / kod som du vill dölja och sedan lägger du till stänga delen i slutet av den koden (HTML-kommentarer kan sträcka sig över flera rader, så du kan öppna en kommentar på säg rad 50 i din kod och stäng den på rad 75 utan problem), då kommer alla HTML-element som faller inom den kommentaren inte längre att visas i webbläsare. De kommer att finnas kvar i din kod, men påverkar inte den visuella visningen av sidan. Om du behöver testa en sida för att se om ett visst avsnitt orsakar problem etc. är det bättre att kommentera det området framför att ta bort det. Om kommentarer i avsnittet med koden visar sig inte vara problemet kan du enkelt ta bort kommentarbitarna och den 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 webbplatsen.
En bra användning av HTML-kommentarer under utvecklingen är när du bygger en lyhörd webbplats. Eftersom olika delar av webbplatsen kommer att ändra sitt utseende baserat på olika skärmstorlekar, inklusive vissa områden som kanske inte visas alls, att använda kommentarer för att växla delar av en sida till eller från kan vara ett snabbt och enkelt trick att använda under utvecklingen.
När det gäller prestanda
Jag har sett några webbproffs föreslår att kommentarer ska tas bort från HTML- och CSS-filer för att raka ned skärpan på dessa filer och skapa sidor som laddas snabbare. Medan jag håller med om att sidor borde vara optimerad för prestanda och bör laddas snabbt finns det fortfarande en plats för smart användning av kommentarer i kod. Kom ihåg att dessa kommentarer är avsedda att göra det lättare att arbeta på en webbplats i framtiden, så länge du inte överdriver det med kommentarer till varje rad i din kod, den lilla mängden filstorlek som läggs till på en sida på grund av kommentarer bör vara mer än godtagbar.
Tips för användning av kommentarer
Några saker att tänka på eller komma ihåg när du använder HTML-kommentarer:
- Kommentarer kan bestå av flera rader.
- 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 som "stänger av" områden på en webbplats bör inte göra det till produktion om inte denna ändring är en tillfällig som kommer att reverseras i kort ordning (som att ha ett varningsmeddelande på eller av som behövs).