Korrekt kommenteret HTML markup er en vigtig del af en velbygget webside. Disse kommentarer er lette at tilføje, og enhver, der skal arbejde på webstedets kode i fremtiden (inklusive dig selv eller medlemmer af ethvert team, du arbejder sammen med) vil takke dig for disse kommentarer.
Sådan tilføjes HTML-kommentarer
HTML kan oprettes med en standard teksteditor som f.eks. Notepad ++ 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 at oprette HTML, hvis du arbejder direkte med koden, tilføjer du HTML-kommentarer som denne:
Tilføj den første del af HTML-kommentar-tagget:
Efter det første stykke af kommentaren skal du skrive den tekst, du gerne vil have vist til denne kommentar. Dette vil sandsynligvis være instruktioner til din eller en anden udvikler i fremtiden. For eksempel, hvis du vil angive, hvor et bestemt afsnit på en side begynder eller slutter i markeringen, kan du bruge en kommentar til at specificere det.
Når teksten i din kommentar er færdig, skal du lukke kommentar-tagget således:
Så i alt vil din kommentar se sådan ud:
Det er virkelig så simpelt.
Visningen af kommentarer
Eventuelle kommentarer, du tilføjer til din HTML-kode, vises i den kode, når nogen viser kilden til websiden eller åbner HTML'en i en editor for at foretage nogle ændringer. Kommentarteksten vises dog ikke i webbrowseren, når normale besøgende kommer til siden. I modsætning til andre HTML-elementer, herunder afsnit, overskrifter eller lister, der faktisk påvirker siden inde i disse browsere, er kommentarer virkelig "bag kulisserne" på siden.
Kommentarer til testformål
Da kommentarer ikke vises i en webbrowser, kan de bruges til at "deaktivere" dele af en side under sidetest eller udvikling. Hvis du tilføjer den indledende del af en kommentar direkte før den del af din side / kode, du vil skjule, og derefter tilføjer du lukke del i slutningen af denne kode (HTML-kommentarer kan spænde over flere linjer, så du kan åbne en kommentar på f.eks. linje 50 i din kode og luk det på linje 75 uden problemer), så uanset hvilke HTML-elementer, der falder inden for den kommentar, vises ikke længere i browser. De forbliver i din kode, men påvirker ikke den visuelle visning af siden. Hvis du har brug for at teste en side for at se, om et bestemt afsnit forårsager problemer osv., Foretrækkes det at kommentere dette område frem for at slette det. Med kommentarer, hvis det pågældende afsnit af kode viser sig ikke at være problemet, kan du nemt fjerne kommentarstykkerne, og den kode vises igen. Bare vær sikker på at disse kommentarer, der bruges til test, ikke gør det til produktionswebsteder. Hvis et område på en side ikke skal vises, vil du fjerne koden og ikke bare kommentere den, før du starter dette websted.
En god brug af HTML-kommentarer under udvikling er, når du bygger et lydhørt websted. Fordi forskellige dele af dette websted ændrer deres udseende baseret på forskellige skærmstørrelser, herunder nogle områder, som muligvis ikke vises overhovedet, kan det være et hurtigt og nemt trick at bruge under udvikling ved hjælp af kommentarer til at slå sektioner på en side til eller fra.
Med hensyn til ydeevne
Jeg har set nogle webfagfolk foreslå, at kommentarer skal fjernes fra HTML- og CSS-filer for at barbere skære ned på størrelsen på disse filer og oprette sider med hurtigere indlæsning. Mens jeg er enig i, at sider skal være optimeret til ydeevne og skal indlæses hurtigt, er der stadig et sted til smart brug af kommentarer i kode. Husk, at disse kommentarer er beregnet til at gøre det lettere at arbejde på et websted i fremtiden, så længe du ikke overdriver det med kommentarer tilføjet til hver linje i din kode, skal den lille mængde filstørrelse, der føjes til en side på grund af kommentarer, være mere end acceptabelt.
Tips til brug af kommentarer
Et par ting at være opmærksom 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, spore ændringer eller hvad du vil.
- Kommentarer, der "slukker" for områder på et websted, bør ikke gøre det til produktion, medmindre denne ændring er en midlertidig en, der vendes i kort rækkefølge (som at have en advarselsmeddelelse slået til eller fra som havde brug for).