Kako se komentirati kod kod pisanja HTML-a

Kada pregledavate web stranicu u pregledniku, vidite vizualni prikaz onoga što taj softver (web preglednik) prikazuje na temelju koda određene web stranice. Ako pogledate taj izvorni kôd web stranice, vidjet ćete dokument sastavljen od različitih HTML elemenata, uključujući odlomke, zaglavlja, popise, veze, slike i drugo. Svi se ovi elementi prikazuju na zaslonu posjetitelja kao dio prikaza web stranice. Jedna stvar koju možete naći u HTML kodu koji nije prikazan na zaslonu osobe su ono što se zove "HTML komentari".

Što je komentar?

Komentar je niz koda unutar HTML-a, XML-a ili CSS-a koji preglednik ili parser ne pregledava ili ne ponaša. Jednostavno je napisano u kod za pružanje informacija o tom kodu ili drugu povratnu informaciju od razvojnih programera kodova.

Većina programskih jezika ima komentare, programer kodova obično koristi za jedan ili čak više od jednog od sljedećih razloga:

• Opišite i objasnite kompliciranu šifru nekome tko će morati raditi na njemu u budućnosti - uključujući i sebe! Mogu se vratiti u šifru 3 ili 6 od 12 mjeseci ili više i ne sjetiti se zašto su učinili nešto na neki način. Komentari mogu pomoći odgovoriti na njihova pitanja i podsjećati ih na to gdje im je um bio kad su prvi put razvili tu stranicu.
• Navedite pojedinosti o tome kada je kôd uređen ili pregledan. To može biti korisno i djelovati nešto poput registra razvoja kada je web stranica zadnji put radila.
• Uklonite odjeljke koda, ali ostavite ih dostupnima za kasniju upotrebu. To se često događa prilikom testiranja web mjesta i ispravljanja pogrešaka. Ako imate problem na nekom web mjestu i niste sigurni što to uzrokuje, možete komentirajte odjeljke jedan po jedan za karantenu i identificirati problem te raditi na popravci za sve probleme koji imate.
• Razgovarajte s drugim programerima koji rade na kodu. To će vjerojatno biti učinjeno tijekom razvoja kao način dijeljenja pojedinosti s drugima koji rade na kodu u isto vrijeme. Ako su ovi komentari čisto razvojni razgovori, najbolja je praksa da ih uklonite iz koda prije pokretanja web mjesta.

Tradicionalno, komentari u HTML-u koriste se za gotovo sve elemente, od objašnjenja složenih struktura tablica do informativnih primjedbi sadržaja same stranice. Budući da se komentari ne prikazuju u pregledniku, možete ih dodati bilo gdje u HTML-u i nemate briga o tome što će učiniti kada klijent pregleda web mjesto.

Kako napisati komentare

Pisanje komentara u HTML, XHTML i XML je vrlo jednostavno. Jednostavno okružite tekst koji želite komentirati sa sljedećim:

i

Kao što možete vidjeti, ovi komentari počinju s "manje od simbola", uz uskličnik i dvije crtice. Komentar završava s još dvije crtice i "veći od: simbolom. Između tih znakova možete napisati sve što želite sastaviti tijelo komentara.

U CSS-u, to je malo drugačije, pomoću komentara s kodom C, a ne HTML-om. Započnete s kosom prema naprijed, a zatim zvjezdicom. Završavate komentar s obrnutom točkom, zvjezdicom nakon čega slijedi koso udesno.

Komentari su Dying Art

Većina programera zna vrijednost korisnih komentara. Komentirani kôd olakšava prijenos tog koda s jednog člana tima u drugi. Komentari vam pomažu timu za provjeru kvalitete za testiranje koda jer mogu reći što je razvojni programer želio - čak i ako to nije postignuto. Nažalost, s popularnošću platforma za stvaranje web stranica kao što je Wordpress, koje vam omogućuju da se pokrenete i odaberu temu koja mnogo, ako ne i sve, za HTML, komentari se često ne koriste web timovima. To je zato što su komentari jako teško vidjeti u većini alata za vizualno stvaranje ako ne radite izravno s kodom. Na primjer, umjesto da se vidi, pri vrhu web stranice:

Vizualni alat pokazuje malu ikonu koja označava da postoji komentar. Ako dizajner ne fizički otvori komentar, on nikada neće vidjeti. A u slučaju gornje stranice, može uzrokovati probleme ako uređuje stranicu i da je uređivanje previše napisano pomoću skripte navedene u komentaru.

Što može biti učinjeno?

1. Napišite smislene i korisne komentare. Nemojte očekivati ​​da drugi ljudi pročitaju vaše komentare ako su predugo ili ne uključuju korisne informacije.
2. Kao programer, trebali biste stalno pregledajte sve komentare koje vidite na stranici.
3. Koristite alate koje pružaju autorski programi koji vam omogućuju dodavanje komentara.
4. Pomoću upravljanja sadržajem možete upravljati načinom uređivanja stranica.

Čak i ako ste jedina osoba koja uređuje vaše web stranice, komentari mogu biti korisni. Ako samo jednom uredite kompliciranu stranicu, lako je zaboraviti kako ste izgradili stol ili sastavili CSS. S komentarima, ne morate se sjetiti, kao što je to točno napisano za vas.