Cilat janë komentet HTML dhe Si përdoren ato
a Kur shihni një faqe në një shfletues, shihni një paraqitje vizuale të asaj se ajo pjesë e softuerit (shfletuesi i internetit) po shfaqet në bazë të kodit të një faqeje të veçantë. Nëse e shihni atë kod burimor të faqes, do të shihni një dokument të përbërë nga elementë të ndryshëm HTML, duke përfshirë paragrafët, titujt, listat, lidhjet, imazhet dhe të tjera. Të gjitha këto elemente janë dhënë nga shfletuesi në ekranin e vizitorit si pjesë e shfaqjes së faqes së internetit. Një gjë që mund të gjeni në kodin HTML që nuk është dhënë në ekranin e një personi janë ato që njihen si "komentet e HTML".
Çfarë është një koment?
Një koment është një varg kodesh brenda HTML, XML ose CSS që nuk shikohet ose veprohet nga shfletuesi ose analiza. Është shkruar thjesht në kodin për të dhënë informacion rreth atij kodi ose reagime të tjera nga zhvilluesit e kodeve.
Shumica e gjuhëve programuese kanë komente, ato përdoren zakonisht nga zhvilluesi i kodit për një apo edhe më shumë se një nga arsyet e mëposhtme:
- Përshkruani dhe shpjegoni kodin e komplikuar për dikë që mund të duhet të punojë në të ardhmen - përfshirë veten e tyre! Ata mund të kthehen në kodin 3 ose 6 të 12 muajve ose më vonë dhe të mos kujtojnë pse ata bënë diçka në një mënyrë të caktuar. Komentet mund të ndihmojnë t'i përgjigjen pyetjeve të tyre dhe t'u kujtojnë se ku mendja e tyre ishte kur ata zhvillonin në fillim atë faqe.
- Jepni hollësi rreth kodit kur është redaktuar ose rishikuar. Kjo mund të jetë informacion i dobishëm dhe të veprojë disi si një regjistër zhvillimi i kohës kur një faqe është punuar së fundi.
- Hiqni seksionet e kodit, por lini ato në dispozicion për përdorim të mëvonshëm. Kjo shpesh bëhet gjatë testimit të faqes dhe debugging. Nëse keni ndonjë problem në një vend dhe nuk jeni të sigurt se çfarë po e shkakton, ju mund të komentoni seksione një në një kohë për të bërë karantinë dhe për të identifikuar çështjen, dhe pastaj të punoni në një rregullim për çfarëdo problemi që keni.
- Bisedo me zhvilluesit e tjerë që punojnë në kodin. Kjo ka të ngjarë të bëhet gjatë zhvillimit si një mënyrë për të ndarë detajet me të tjerët që punojnë në kodin në të njëjtën kohë. Nëse këto komente janë thjesht biseda zhvillimi, është një praktikë më e mirë për t'i hequr ato nga kodi përpara fillimit të një faqeje.
Tradicionalisht, komentet në HTML përdoren për pothuajse çdo element, nga shpjegimet e strukturave të tabelave komplekse në vërejtjet informative të përmbajtjes së vetë faqes. Meqë komentet nuk bëhen në një shfletues, mund t'i shtoni kudo në HTML dhe mos kini asnjë shqetësim se çfarë do të bëjë kur faqja shihet nga një klient.
Si të shkruani komente
Shkrimi i komenteve në HTML, XHTML dhe XML është shumë i lehtë. Thjesht rrethoni tekstin që dëshironi të komentohet me sa vijon:
dhe ->Siç mund ta shikoni, këto komente fillojnë me një "simbol më të vogël", plus një pikë exclaimation dhe dy dashes. Komenti përfundon me dy dasha më shumë dhe një "simbol më të madh se: simbol. Mes atyre personazheve mund të shkruani çfarëdo që dëshironi të bëni në trupin e komentit.
Në CSS, është pak më ndryshe, duke përdorur komentet e kodit C se sa HTML Ju filloni me një prerje të ardhme të ndjekur nga një yll. Ju përfundoni komentin me anën e kundërt të asaj, një yll të ndjekur nga një ulje përpara.
/ * komentuar tekst * /Komentet janë një Dying Art
Shumica e programuesve e dinë vlerën e komenteve të dobishme . Kodi i komentuar e bën më të lehtë që ky kod të transferohet nga një anëtar i ekipit në një tjetër. Komentet ju ndihmojnë ekipin e QA për të provuar kodin, sepse ata mund të tregojnë se çfarë synon zhvilluesi - edhe nëse nuk u arrit. Për fat të keq, me popullaritetin e platformave të krijimit të faqeve të internetit si Wordpress, që ju lejon të merrni dhe të konkuroni me një temë të zgjedhur që trajton shumë, nëse jo të gjitha, të HTML për ju, komentet nuk përdoren shpesh nga ekipet e uebit. Kjo është për shkak se komentet janë me të vërtetë të vështira për t'u parë në shumicën e mjeteve të krijimit vizuel nëse nuk punoni drejtpërdrejt me kodin. Për shembull, në vend që të shohësh, në krye të një faqeje interneti:
Mjeti vizual tregon një ikonë të vogël për të treguar se një koment është atje. Nëse projektuesi nuk e hap fizikisht komentin, ai kurrë nuk mund ta shohë atë. Dhe në rastin e faqes së mësipërme, mund të shkaktojë probleme nëse modifikon faqen dhe se redaktimi mbizotërtohet nga shkrimi i përmendur në koment.
Çfarë mund të bëhet?
- Shkruani komente kuptimplote dhe të dobishme. Mos prisni që njerëzit e tjerë të lexojnë komentet tuaja nëse ato janë tepër të gjata ose nuk përfshijnë informata të dobishme.
- Si një zhvillues, gjithmonë duhet të rishikoni çdo koment që shihni në një faqe.
- Përdorni mjete të siguruara nga programet e autorizimit që ju lejojnë të shtoni komente.
- Përdorni menaxhimin e përmbajtjes për të kontrolluar se si redaktohen faqet.
Edhe nëse jeni i vetmi person që redaktoni faqet tuaja të internetit, komentet mund të jenë të dobishme. Nëse redaktoni vetëm një faqe të ndërlikuar një herë në vit, është e lehtë të harrosh se si ndërtuat tryezën ose krijoi CSS. Me komente, ju nuk duhet të mbani mend, ashtu siç është shkruar aty për ju.
Artikulli origjinal nga Jennifer Krynin. Redaktuar nga Jeremy Girard më 5-05-17