Skip to main content

Hvordan og hvorfor at tilføje kommentarer til din HTML

"180" Movie (Juni 2025)

"180" Movie (Juni 2025)
Anonim

Korrekt kommenteret HTML-markup er en vigtig del af en velbygget webside. Disse kommentarer er nemme at tilføje, og alle der skal arbejde på den pågældende sides kode i fremtiden (inklusive dig selv eller medlemmer af et team, du arbejder med) vil takke for disse kommentarer.

Sådan tilføjes HTML-kommentarer

HTML kan være forfattet med en standard tekst editor, som Notesblok ++ til Windows eller TextEdit til en Mac. Du kan også bruge et webdesign-centreret program som Adobe Dreamweaver eller endda en CMS platform som Wordpress eller ExpressionEngine. Uanset hvilket værktøj du bruger til forfatter-HTML, hvis du arbejder direkte med koden, vil du tilføje HTML-kommentarer som denne:

  1. Tilføj den første del af HTML-kommentærkoden:

  2. Så i alt vil din kommentar se sådan ud:

  3. Det er virkelig så simpelt.

Visningen af ​​kommentarer

Eventuelle kommentarer, som du tilføjer til din HTML-kode, vises i den kode, når nogen ser kilden til websiden eller åbner HTML'en i en editor for at foretage nogle ændringer. Denne kommentartekst vises dog ikke i webbrowseren, når en normal besøgende kommer til webstedet. I modsætning til andre HTML-elementer, herunder afsnit, overskrifter eller lister, som faktisk påvirker siden inde i disse browsere, er kommentarer virkelig "bag kulisserne" af siden.

Kommentarer til testformål

Da kommentarer ikke vises i en webbrowser, kan de bruges til at "slukke" dele af en side under sideprøvning eller -udvikling. Hvis du tilføjer åbningsdelen af ​​en kommentar direkte før den del af din side / kode, du vil skjule, og så tilføjer du den afsluttende del i slutningen af ​​den pågældende kode (HTML-kommentarer kan spænde over flere linjer, så du kan åbne en kommentere sige linje 50 af din kode og luk det på linje 75 uden problemer), så vil ikke alle HTML-elementer, der falder inden for denne kommentar, vises længere i browseren. De forbliver i din kode, men vil ikke påvirke visuel visning af siden. Hvis du har brug for at teste en side for at se, om en bestemt sektion forårsager problemer mv., Er det bedre at kommentere dette område for at slette det. Med kommentarer, hvis den pågældende del af kode ikke er problemet, kan du nemt fjerne kommentaren og den kode vises igen. Bare vær sikker på at disse kommentarer, der bruges til testning, ikke gør det til produktionswebsteder.

Hvis et område på en side ikke skal vises, vil du fjerne koden, ikke bare kommentere det, før du starter det pågældende websted.

En stor brug af HTML-kommentarer under udvikling er, når du opbygger et lydhurtigt websted. Fordi forskellige dele af dette websted vil ændre deres udseende baseret på forskellige skærmstørrelser, herunder nogle områder, der muligvis ikke vises overhovedet, kan det være et hurtigt og nemt trick at bruge under udvikling, hvis du bruger kommentarer til at skifte sektioner på en side på en side.

Med hensyn til ydeevne

Jeg har set nogle web-fagfolk, der foreslår, at kommentarer skal fjernes fra HTML- og CSS-filer for at barbere størrelsen af ​​disse filer og oprette sider med hurtigere indlæsning. Selvom jeg er enig i, at siderne skal optimeres til ydeevne og burde indlæses hurtigt, er der stadig et sted for den smarte brug af kommentarer i kode. Husk, at disse kommentarer skal gøre det nemmere at arbejde på et websted i fremtiden, så længe du ikke forfalder det med kommentarer tilføjet til hver linje i din kode, bliver den lille mængde filstørrelse tilføjet til en side på grund af kommentarer skal være mere end acceptable.

Tips til brug af kommentarer

Et par ting at huske på eller huske, når du bruger HTML-kommentarer:

  • Kommentarer kan være flere linjer.
  • Brug kommentarer til at dokumentere din sides udvikling.
  • Kommentarer kan også dokumentere indhold, tabelrækker eller kolonner, spor ændringer eller hvad du vil.
  • Bemærkninger om at "slukke" områder af et websted bør ikke gøre det til produktion, medmindre denne ændring er en midlertidig, der vil blive omvendt i kort rækkefølge (f.eks. At have en advarselsmeddelelse slået til eller fra efter behov).