När du visar en webbsida i en webbläsare ser du en visuell representation av vad den här mjukvaran (webbläsaren) visar baserat på koden på en viss webbsida. Om du visar källkoden på webbsidan ser du ett dokument som består av olika HTML-element, inklusive stycken, rubriker, listor, länkar, bilder och mer. Alla dessa element görs av webbläsaren på en besökares skärm som en del av webbplatsens display. En sak som du kan hitta i HTML-kod som inte gjorts på en persons skärm är vad som kallas "HTML-kommentarer".
Vad är en kommentar?
En kommentar är en sträng kod i HTML, XML eller CSS som inte ses eller ageras av webbläsaren eller parsern. Det skrivs helt enkelt in i koden för att ge information om den koden eller annan feedback från kodutvecklarna.
De flesta programmeringsspråk har kommentarer, de används vanligtvis av kodens utvecklare för en eller till och med mer än en av följande orsaker:
- Beskriv och förklara komplicerad kod till någon som kanske måste arbeta med det i framtiden - inklusive sig! De kan komma tillbaka till kod 3 eller 6 av 12 månader eller mer senare och kom inte ihåg varför de gjorde något på ett visst sätt. Kommentarer kan hjälpa till att svara på sina frågor och påminna dem om var deras sinne var när de först utvecklade den sidan.
- Ange när koden har redigerats eller granskats. Detta kan vara användbar information och agera något som en utvecklingslogg om när en webbplats senast fungerade.
- Ta bort delar av koden, men lämna dem tillgängliga för senare användning. Detta görs ofta vid testning av webbplatser och debugging. Om du har problem på en webbplats och inte är säker på vad som orsakar det, kan du kommentera avsnitt en åt gången för att karantänera och identifiera problemet och sedan arbeta med en lösning för oavsett problem du har.
- Chatta med andra utvecklare som arbetar med koden. Detta skulle sannolikt ske under utveckling som ett sätt att dela detaljer med andra som arbetar med koden samtidigt. Om dessa kommentarer är rent utvecklingssamtal är det en bra metod att ta bort dem från koden innan en webbplats lanseras.
Traditionellt används kommentarer i HTML för nästan alla element, från förklaringar av komplexa bordstrukturer till informativa anmärkningar om innehållet på själva sidan. Eftersom kommentarer inte görs i en webbläsare kan du lägga till dem var som helst i HTML-filen och oroa dig inte för vad den ska göra när webbplatsen ses av en kund.
Hur man skriver kommentarer
Skriva kommentarer i HTML, XHTML och XML är väldigt enkelt. Helt enkelt omger texten du vill kommentera med följande:
och
Som du kan se börjar dessa kommentarer med en "mindre än symbol", plus ett utropstecken och två bindestreck. Kommentaren slutar med ytterligare två bindestreck och en "större än: symbol". Mellan de här tecknen kan du skriva vad du vill göra i kommentarkroppen.
I CSS är det lite annorlunda, med hjälp av C-kodkommentarer snarare än HTML. Du börjar med ett snedstreck följt av en asterisk. Du avslutar kommentaren med invers av det, en asterisk följt av en framåt snedstreck.
Kommentarer är en döende konst
De flesta programmerare vet värdet av användbara kommentarer. Kommenterad kod gör det enklare för den koden att överföras från en teammedlem till en annan. Kommentarer hjälper dig QA-teamet att testa koden eftersom de kan berätta vad utvecklaren tänkte - även om den inte uppnåddes. Tyvärr, med popularitet av webbplatformar som Wordpress, som tillåter dig att komma igång med ett valt tema som hanterar mycket, om inte alla, av HTML för dig, används kommentarer inte så ofta av webblag. Detta beror på att kommentarerna är mycket svåra att se i de flesta visuella verktygsverktygen om du inte arbetar direkt med koden. Till exempel, snarare än att se, högst upp på en webbsida:
Det visuella verktyget visar en liten ikon för att ange att en kommentar finns där. Om designer inte fysiskt öppnar kommentaren kan han aldrig se den. Och när det gäller ovanstående sida kan det orsaka problem om hon redigerar sidan och att redigering är överskrivet av det skript som nämns i kommentaren.
Vad kan göras?
- Skriv meningsfulla och användbara kommentarer. Förvänta dig inte att andra människor läser dina kommentarer om de är för långa eller inte innehåller bra information.
- Som utvecklare borde du alltid recensera eventuella kommentarer som du ser på en sida.
- Använd verktyg som tillhandahålls av författarprogrammen som låter dig lägga till kommentarer.
- Använd innehållshantering för att kontrollera hur sidorna redigeras.
Även om du är den enda personen som redigerar dina webbsidor kan kommentarer vara användbara. Om du bara redigerar en komplicerad sida en gång per år är det lätt att glömma hur du byggt bordet eller sammanför CSS. Med kommentarer, du behöver inte komma ihåg, som det är skrivet just där för dig.
