Ispravno komentirano HTML označavanje je važan dio dobro izgrađene web stranice. Te se komentare lako dodaje i svi koji budu morali raditi na kodu te web lokacije (uključujući sebe ili članove bilo kojeg tima s kojim radite) zahvalit će vam na tim komentarima.
Kako dodati HTML komentare
HTML se može napisati u standardnom uređivaču teksta, kao što je Notepad ++ za Windows ili TextEdit za Mac. Također možete koristiti program usmjeren na web dizajn poput Adobe Dreamweaver ili čak CMS platformu poput Wordpress ili ExpressionEngine. Bez obzira na alat koji koristite za izradu HTML-a, ako radite izravno s kodom, dodali biste HTML komentare poput ovog:
Dodajte prvi dio HTML oznake komentara:
Nakon uvodnog dijela komentara napišite bilo koji tekst koji želite da se pojavljuje za ovaj komentar. To će u budućnosti vjerojatno biti upute za vašeg ili drugog programera. Na primjer, ako želite odrediti gdje određeni odjeljak na stranici započinje ili završava u označavanju, možete upotrijebiti komentar da biste to detaljno opisali.
Kada je tekst vašeg komentara završen, zatvorite oznaku komentara ovako:
Dakle, vaš će komentar izgledati otprilike ovako:
Stvarno je tako jednostavno.
Prikaz komentara
Svi komentari koje dodate u HTML kôd pojavit će se u tom kodu kada netko pregledava izvor web stranice ili otvara HTML u uređivaču da izvrši neke promjene. Tekst tog komentara neće se pojaviti u web pregledniku kada normalni posjetitelji dođu na web mjesto. Za razliku od ostalih HTML elemenata, uključujući odlomke, naslove ili popise, koji zapravo utječu na stranicu unutar tih preglednika, komentari su doista dijelovi stranice "iza kulisa".
Komentari za svrhe ispitivanja
Budući da se komentari ne pojavljuju u web pregledniku, mogu se koristiti za "isključivanje" dijelova stranice tijekom testiranja ili razvoja stranice. Ako uvodni dio komentara dodate neposredno prije dijela stranice / koda koji želite sakriti, a zatim dodate završni dio na kraju tog koda (HTML komentari mogu obuhvaćati više redaka, tako da možete otvoriti komentar na recimo retku 50 vašeg koda i zatvorite ga u redak 75 bez problema), tada se bilo koji HTML elementi koji spadaju u taj komentar više neće prikazivati u preglednik. Oni će ostati u vašem kodu, ali neće utjecati na vizualni prikaz stranice. Ako trebate testirati stranicu kako biste vidjeli uzrokuje li određeni odjeljak probleme itd., Komentiranje tog područja poželjnije je nego brisanje. Uz komentare, ako se pokaže da nije u pitanju dio dotičnog koda, možete jednostavno ukloniti dijelove komentara i taj će se kôd ponovno prikazati. Samo budite sigurni da ovi komentari koji se koriste za testiranje ne ulaze u produkcijske web stranice. Ako područje stranice ne bi trebalo biti prikazano, želite ukloniti kôd, a ne samo ga komentirati, prije nego što pokrenete tu web lokaciju.
Jedna od sjajnih upotreba HTML komentara tijekom razvoja je kada gradite responzivna web stranica. Budući da će različiti dijelovi te stranice promijeniti svoj izgled na temelju različite veličine zaslona, uključujući neka područja koja se možda uopće neće prikazati, upotreba komentara za uključivanje ili isključivanje odjeljaka stranice može biti brz i jednostavan trik za korištenje tijekom razvoja.
Što se tiče izvedbe
Vidio sam da neki web profesionalci predlažu da komentare treba ukloniti iz HTML i CSS datoteka kako bi se obrijala veličina tih datoteka i stvorile stranice s bržim učitavanjem. Iako se slažem da stranice trebaju biti optimiziran za izvedbu i trebao bi se brzo učitati, još uvijek postoji mjesto za pametnu upotrebu komentara u kodu. Zapamtite, ovi su komentari namijenjeni olakšavanju rada na web mjestu u budućnosti, sve dok ne pretjerate s komentari dodani u svaki redak vašeg koda, mala količina datoteke dodana na stranicu zbog komentara trebala bi biti veća od prihvatljiv.
Savjeti za upotrebu komentara
Nekoliko stvari koje biste trebali imati na umu ili ih trebate imati na umu kada koristite HTML komentare:
- Komentari mogu biti u više redaka.
- Pomoću komentara dokumentirajte razvoj vaše stranice.
- Komentari također mogu dokumentirati sadržaj, retke ili stupce tablice, pratiti promjene ili sve što želite.
- Komentari koji "isključuju" područja web mjesta ne bi trebali pretvoriti u produkciju, osim ako ova promjena nije privremeni koji će se obrnuti kratkim redoslijedom (poput uključivanja ili isključivanja poruke upozorenja kao potrebno).