Skikkelig kommentert HTML markering er en viktig del av en velbygd webside. Disse kommentarene er enkle å legge til, og alle som trenger å jobbe med nettstedets kode i fremtiden (inkludert deg selv eller medlemmer av et hvilket som helst team du jobber med) vil takke deg for kommentarene.
Hvordan legge til HTML-kommentarer
HTML kan forfattes med en standard teksteditor, som Notepad ++ for Windows eller TextEdit for en Mac. Du kan også bruke et webdesign-sentrisk program som Adobe Dreamweaver eller til og med en CMS-plattform som Wordpress eller ExpressionEngine. Uansett verktøyet du bruker for å lage HTML, hvis du jobber direkte med koden, vil du legge til HTML-kommentarer som dette:
Legg til den første delen av HTML-kommentarkoden:
Etter den første delen av kommentaren, skriv teksten du vil vises for denne kommentaren. Dette vil sannsynligvis være instruksjoner for din eller en annen utvikler i fremtiden. Hvis du for eksempel vil angi hvor et bestemt avsnitt på en side begynner eller slutter i markeringen, kan du bruke en kommentar til å detaljere det.
Når teksten i kommentaren din er fullført, lukker du merkelappen slik:
Så totalt sett vil kommentaren din se slik ut:
Det er virkelig så enkelt.
Visningen av kommentarer
Eventuelle kommentarer du legger til HTML-koden, vises i den koden når noen viser kilden til websiden eller åpner HTML-en i en editor for å gjøre noen endringer. Kommentarteksten vil imidlertid ikke vises i nettleseren når vanlige besøkende kommer til nettstedet. I motsetning til andre HTML-elementer, inkludert avsnitt, overskrifter eller lister, som faktisk påvirker siden i disse nettleserne, er kommentarene virkelig "bak kulissene" på siden.
Kommentarer til testformål
Fordi kommentarer ikke vises i en nettleser, kan de brukes til å "slå av" deler av en side under sidetesting eller utvikling. Hvis du legger til åpningsdelen av en kommentar rett før den delen av siden / koden du vil skjule, og deretter legger du til lukker delen på slutten av den koden (HTML-kommentarer kan strekke seg over flere linjer, slik at du kan åpne en kommentar på si linje 50 i koden og lukk den på linje 75 uten problemer), så vil HTML-elementene som faller inn under den kommentaren ikke lenger vises i nettleser. De blir værende i koden din, men vil ikke påvirke den visuelle visningen av siden. Hvis du trenger å teste en side for å se om en bestemt seksjon gir problemer osv., Er det å foretrekke å kommentere det området fremfor å slette det. Med kommentarer, hvis den aktuelle delen av koden viser seg å ikke være problemet, kan du enkelt fjerne kommentarbitene, og den koden vises igjen. Bare vær sikker på at disse kommentarene som brukes til testing ikke gjør det til produksjonsnettsteder. Hvis et område på en side ikke skal vises, vil du fjerne koden, ikke bare kommentere den, før du starter nettstedet.
En god bruk av HTML-kommentarer under utvikling er når du bygger et responsivt nettsted. Fordi forskjellige deler av nettstedet vil endre utseendet basert på forskjellige skjermstørrelser, inkludert noen områder som kanskje ikke vises i det hele tatt, kan det være et raskt og enkelt triks å bruke kommentarer under utvikling ved å bruke kommentarer til å slå deler av en side av eller på.
Angående ytelse
Jeg har sett noen fagpersoner på nettet foreslå at kommentarer skal fjernes fra HTML- og CSS-filer for å barbere kutte ned størrelsen på disse filene og skape sider som lastes inn raskere. Mens jeg er enig i at sider skal være optimalisert for ytelse og skal lastes raskt, er det fremdeles et sted for smart bruk av kommentarer i kode. Husk at disse kommentarene er ment å gjøre det lettere å jobbe på et nettsted i fremtiden, så lenge du ikke overdriver det med kommentarer lagt til hver linje i koden din, bør den lille mengden filstørrelse som legges til på en side på grunn av kommentarer være mer enn akseptabel.
Tips for bruk av kommentarer
Noen få ting å være oppmerksom på eller huske når du bruker HTML-kommentarer:
- Kommentarer kan være flere linjer.
- Bruk kommentarer for å dokumentere utviklingen av siden din.
- Kommentarer kan også dokumentere innhold, tabellrader eller kolonner, spore endringer eller hva du vil.
- Kommentarer som "slår av" områder på et nettsted, bør ikke gjøre det til produksjon med mindre denne endringen er en midlertidig som vil bli reversert i kort rekkefølge (som å ha en varselmelding slått på eller av som behov for).