Når du ser en nettside i en nettleser, ser du en visuell fremstilling av hva det stykke programvare (nettleseren) viser på grunnlag av koden til en bestemt nettside. Hvis du ser kildekoden til nettsiden, ser du et dokument som består av ulike HTML-elementer, inkludert avsnitt, overskrifter, lister, lenker, bilder og mer. Alle disse elementene blir gjengitt av nettleseren på en besøkers skjerm som en del av visning av nettstedet. En ting du finner i HTML-koden som ikke blir gjengitt på en persons skjerm, er det som kalles "HTML-kommentarer".
Hva er en kommentar?
En kommentar er en streng med kode i HTML, XML eller CSS som ikke vises eller påvirkes av nettleseren eller parseren. Det er enkelt skrevet inn i koden for å gi informasjon om den koden eller annen tilbakemelding fra kodeutviklerne.
De fleste programmeringsspråk har kommentarer, de blir ofte brukt av kodens utvikler for en eller enda mer enn en av følgende grunner:
- Beskriv og forklar komplisert kode til noen som kanskje må jobbe med det i fremtiden - inkludert seg selv! De kan komme tilbake til kode 3 eller 6 av 12 måneder eller mer senere og ikke huske hvorfor de gjorde noe på en bestemt måte. Kommentarer kan bidra til å svare på spørsmålene sine og minne dem om hvor deres sinn var når de først utviklet den siden.
- Oppgi detaljer om når koden ble redigert eller gjennomgått. Dette kan være nyttig informasjon og virke noe som en utviklingslogg av når et nettsted var sist arbeidet.
- Fjern deler av koden, men la dem være tilgjengelige for senere bruk. Dette gjøres ofte ved testing og feilsøking. Hvis du har et problem på et nettsted og ikke er sikker på hva som forårsaker det, kan du kommentere ut seksjoner en om gang for å karantene og identifisere problemet, og deretter jobbe med en løsning for uansett problemer du har.
- Chat med andre utviklere som jobber med koden. Dette vil trolig bli gjort under utvikling som en måte å dele detaljer med andre som arbeider med koden på samme tid. Hvis disse kommentarene er rent utviklingssamtaler, er det en god praksis å fjerne dem fra koden før et nettsted lanseres.
Tradisjonelt brukes kommentarer i HTML til nesten alle elementer, fra forklaringer av komplekse tabellstrukturer til informative kommentarer til innholdet på selve siden. Siden kommentarer ikke gjengis i en nettleser, kan du legge dem til hvor som helst i HTML-en og har ingen bekymringer for hva det vil gjøre når nettstedet blir sett av en kunde.
Hvordan skrive kommentarer
Skrive kommentarer i HTML, XHTML og XML er veldig enkelt. Bare omgir teksten du vil ha kommentert med følgende:
og
Som du kan se, begynner disse kommentarene med et "mindre enn symbol", pluss et utropstegn og to bindestreker. Kommentaren avsluttes med to flere bindestreker og et "større enn" -symbol. Mellom disse tegnene kan du skrive hva du vil gjøre opp i kommentarfeltet.
I CSS er det litt annerledes, ved hjelp av C-kodekommentarer i stedet for HTML. Du begynner med et fremoverstrekk etterfulgt av en stjerne. Du avslutter kommentaren med det omvendte av det, en stjerne etterfulgt av et fremoverstrekk.
Kommentarer er en døende kunst
De fleste programmører vet verdien av nyttige kommentarer. Kommentert kode gjør det enklere for den koden å bli overført fra ett lagmedlem til en annen. Kommentarer hjelper deg med QA-teamet til å teste koden fordi de kan fortelle hva utvikleren ment - selv om den ikke ble oppnådd. Dessverre, med populariteten til nettsideforfatterplattformer som Wordpress, som gir deg mulighet til å komme i gang med et valgt tema som håndterer mye, om ikke alt, HTML for deg, blir kommentarer ikke brukt så ofte av webteam. Dette skyldes at kommentarene er veldig vanskelig å se i de fleste visuelle verktøy for redigering hvis du ikke jobber direkte med koden. For eksempel, i stedet for å se, på toppen av en nettside:
Det visuelle verktøyet viser et lite ikon for å indikere at en kommentar er der. Hvis designer ikke fysisk åpner kommentaren, kan han aldri se den. Og i tilfelle av siden ovenfor kan det føre til problemer hvis hun redigerer siden, og at redigering er overskrevet av skriptet nevnt i kommentaren.
Hva kan bli gjort?
- Skriv meningsfulle og nyttige kommentarer. Forvent ikke at andre skal lese kommentarene dine hvis de er for lange eller ikke inneholder nyttig informasjon.
- Som utvikler bør du alltid vurder eventuelle kommentarer du ser på en side.
- Bruk verktøy som leveres av forfatterprogrammene som lar deg legge til kommentarer.
- Bruk innholdshåndtering for å kontrollere hvordan sidene er redigert.
Selv om du er den eneste personen som redigerer nettsidene dine, kan kommentarer være nyttige. Hvis du bare redigerer en komplisert side en gang i året, er det lett å glemme hvordan du bygget bordet eller sette sammen CSS. Med kommentarer, trenger du ikke å huske, som det står skrevet der for deg.
