Når du ser en webside i en browser, ser du en visuel repræsentation af, hvad det softwareprogram (webbrowseren) viser ud fra koden på en bestemt webside. Hvis du ser kildekoden på websiden, vil du se et dokument bestående af forskellige HTML-elementer, herunder afsnit, overskrifter, lister, links, billeder og meget mere. Alle disse elementer gengives af browseren på en besøgendes skærm som en del af displayet på hjemmesiden. En ting du kan finde i HTML-kode, der ikke er gengivet på en persons skærm, er, hvad der er kendt som "HTML-kommentarer".
Hvad er en kommentar?
En kommentar er en streng kode inden for HTML, XML eller CSS, der ikke ses eller handles af browseren eller parseren. Det er simpelthen skrevet i koden for at give oplysninger om den kode eller anden feedback fra kodeudviklerne.
De fleste programmeringssprog har kommentarer, de bruges almindeligvis af kodeudvikleren til en eller endda mere end en af følgende årsager:
- Beskriv og forklar kompliceret kode til en person, der måske skal arbejde på det i fremtiden - inklusiv sig selv! De kan komme tilbage til kode 3 eller 6 af 12 måneder eller mere senere og ikke huske hvorfor de gjorde noget på en bestemt måde. Kommentarer kan hjælpe med at besvare deres spørgsmål og minde dem om, hvor deres sind var, da de først udviklede den side.
- Giv oplysninger om, hvornår koden blev redigeret eller gennemgået. Dette kan være nyttige oplysninger og virke lidt som en udviklingslogbog om, hvornår et websted sidst blev arbejdet.
- Fjern dele af koden, men lad dem være tilgængelige til senere brug. Dette gøres ofte under test af websteder og debugging. Hvis du har et problem på et websted og ikke er sikker på, hvad der forårsager det, kan du kommentere sektioner én ad gangen for at karantæne og identificere problemet, og derefter arbejde på en løsning for uanset de problemer, du har.
- Chat med andre udviklere, der arbejder med koden. Dette vil sandsynligvis ske under udvikling som en måde at dele detaljer med andre, der arbejder på koden på samme tid. Hvis disse kommentarer er rent udviklingssamtaler, er det en god praksis at fjerne dem fra koden, før et websted startes.
Traditionelt bruges kommentarer i HTML til næsten alle elementer, fra forklaringer af komplekse bordstrukturer til informative bemærkninger til indholdet af selve siden. Da kommentarer ikke gengives i en browser, kan du tilføje dem overalt i HTML'en og har ingen bekymringer for, hvad det vil gøre, når webstedet ses af en kunde.
Hvordan man skriver kommentarer
Skrivning af kommentarer i HTML, XHTML og XML er meget nemt. Du skal blot omslutte den tekst, du vil have kommenteret, med følgende:
og
Som du kan se, begynder disse kommentarer med et "mindre end symbol", plus et udråbstegn og to bindestreger. Kommentaren slutter med to punkter og et "større end: symbol". Mellem disse tegn kan du skrive, hvad du vil gøre op i kommentaren.
I CSS er det lidt anderledes, ved hjælp af C-kode kommentarer snarere end HTML. Du begynder med et fremad skråstreg efterfulgt af en stjerne. Du afslutter kommentaren med den omvendte af den, en stjerne efterfulgt af et fremad skråstreg.
Kommentarer er en døende kunst
De fleste programmører kender værdien af nyttige kommentarer. Kommenterede kode gør det lettere for denne kode at overføres fra et holdmedlem til en anden. Kommentarer hjælper dig med QA-teamet til at teste koden, fordi de kan fortælle hvad udvikleren havde til hensigt - selvom den ikke var opnået. Desværre, med populariteten af hjemmesideforfatterplatforme som Wordpress, som giver dig mulighed for at komme i gang med et valgt tema, der håndterer meget, hvis ikke alle, HTML til dig, bruges kommentarer ikke så ofte af webteams. Dette skyldes, at kommentarerne er meget vanskelige at se i de fleste visuelle redigeringsværktøjer, hvis du ikke arbejder direkte med koden. For eksempel i stedet for at se øverst på en webside:
Det visuelle værktøj viser et lille ikon for at indikere, at der er en kommentar. Hvis designer ikke fysisk åbner kommentaren, kan han aldrig se den. Og i tilfælde af ovenstående side kan det medføre problemer, hvis hun redigerer siden, og at redigering er overskrevet af det script, der er nævnt i kommentaren.
Hvad kan der gøres?
- Skriv meningsfulde og nyttige kommentarer. Forvent ikke andre mennesker at læse dine kommentarer, hvis de er for lange eller ikke indeholder nyttige oplysninger.
- Som udvikler skal du altid gennemgå eventuelle kommentarer, du ser på en side.
- Brug værktøjer, der leveres af forfatterprogrammerne, som giver dig mulighed for at tilføje kommentarer.
- Brug indholdshåndtering til at kontrollere, hvordan siderne redigeres.
Selvom du er den eneste person, der redigerer dine websider, kan kommentarer være nyttige. Hvis du kun redigerer en kompliceret side en gang om året, er det nemt at glemme, hvordan du bygget bordet eller sammensætter CSS'en. Med kommentarer, behøver du ikke at huske, som det er skrevet lige der for dig.
