Riktig kommentert HTML-oppslag er en viktig del av en velbygd nettside. Disse kommentarene er enkle å legge til, og alle som må jobbe på den sidenes kode i fremtiden (inkludert deg selv eller medlemmer av et lag du jobber med) vil takke deg for kommentarene.
Slik legger du til HTML-kommentarer
HTML kan forfatteres med en standard tekstredigerer, som Notisblokk ++ 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 hvilket verktøy du bruker til forfatter-HTML, hvis du jobber direkte med koden, vil du legge til HTML-kommentarer som dette:
-
Legg til den første delen av HTML-kommentarkoden:
-
Så totalt sett vil din kommentar se slik ut:
-
Det er så enkelt.
Visningen av kommentarer
Eventuelle kommentarer du legger til i HTML-koden din, vises i den koden når noen ser kilden til nettsiden eller åpner HTML-en i en rediger for å gjøre noen endringer. Kommentateksten vises imidlertid ikke i nettleseren når en vanlig besøkende kommer til nettstedet. I motsetning til andre HTML-elementer, inkludert avsnitt, overskrifter eller lister, som faktisk påvirker siden inne i nettleserne, er kommentarer virkelig "bak kulissene" på siden.
Kommentarer til prøvingsformå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 direkte før den delen av siden / koden du vil gjemme, og deretter legger du til lukkedelen på slutten av koden (HTML-kommentarer kan spanne flere linjer, slik at du kan åpne en kommentere si linje 50 av koden din og lukk den på linje 75 uten problemer), så vil ikke alle HTML-elementer som kommer inn i denne kommentaren, ikke lenger vises i nettleseren. De vil forbli i koden din, men vil ikke påvirke visuell visning av siden. Hvis du må teste en side for å se om en bestemt seksjon forårsaker problemer, etc., er det viktig å kommentere dette området for å slette det. Med kommentarer, hvis den aktuelle delen av koden ikke er problemet, kan du enkelt fjerne kommentarbitene, og den koden vil bli vist igjen. Bare vær sikker på at disse kommentarene som brukes til testing ikke gjør det til produksjon nettsteder.
Hvis et område på en side ikke skal vises, vil du fjerne koden, ikke bare kommentere den, før du starter den siden.
En god bruk av HTML-kommentarer under utviklingen er når du bygger en responsiv nettside. Fordi ulike deler av dette nettstedet vil endre utseendet deres 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 ved å bruke kommentarer til å bytte deler av en side på eller av.
Om ytelse
Jeg har sett noen webprofessorer foreslår at kommentarer skal fjernes fra HTML- og CSS-filer for å barbere størrelsen på disse filene og opprette sider med raskere lasting. Selv om jeg er enig i at sidene skal optimaliseres for ytelse og burde lastes raskt, er det fortsatt et sted for smart bruk av kommentarer i kode. Husk at disse kommentarene er ment å gjøre det enklere å jobbe på et nettsted i fremtiden, så lenge du ikke forfaller det med kommentarer lagt til i hver linje i koden, blir den lille mengden filstørrelse lagt til en side på grunn av kommentarer bør være mer enn akseptabelt.
Tips for bruk av kommentarer
Noen ting å huske på eller huske når du bruker HTML-kommentarer:
- Kommentarer kan være flere linjer.
- Bruk kommentarer til å 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 av 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 etter behov).
