Kas ir HTML komentāri un kā tie tiek izmantoti
aJa pārlūkprogrammā pārlūkprogrammā tiek skatīta tīmekļa lapa, jūs redzat vizuālo attēlojumu par to, kāda šī programmatūras daļa (tīmekļa pārlūkprogramma) tiek rādīta, pamatojoties uz konkrētas tīmekļa lapas kodu. Ja redzat tīmekļa lapas avota kodu , jūs redzēsiet dokumentu, kas sastāv no dažādiem HTML elementiem, ieskaitot punktus, virsrakstus, sarakstus, saites, attēlus un citus. Visus šos elementus apmeklētāja ekrānā attēlo pārlūks kā daļu no tīmekļa vietnes parādīšanas. Viena lieta, ko jūs varat atrast HTML kodā, kas netiek padarīta par personas ekrānu, ir tādas, kas tiek saukts par "HTML komentāriem".
Kas ir komentārs?
Komentārs ir HTML koda, XML vai CSS koda virkne, kuru pārlūks vai analizētājs nav aplūkojis vai rīkojies. Tas ir vienkārši ierakstīts kodā, lai sniegtu informāciju par šo kodu vai citām atsauksmēm no kodu izstrādātājiem.
Lielākajai daļai programmēšanas valodu ir komentāri, tos parasti izmanto koda izstrādātājs vienam vai pat vairākiem no šādiem iemesliem:
- Aprakstiet un paskaidrojiet sarežģīto kodu cilvēkam, kurš, iespējams, nākotnē strādās ar to - arī sevi! Viņi var atgriezties kodā 3 vai 6 no 12 mēnešiem vai vēlāk, un neatceros, kāpēc viņi kaut ko kaut kādā veidā darīja. Komentāri var palīdzēt atbildēt uz viņu jautājumiem un atgādināt viņiem par to, kur viņu prātā bija, kad viņi pirmo reizi izstrādāja šo lapu.
- Sniedziet informāciju par to, kad kods tika rediģēts vai pārskatīts. Tas var būt noderīga informācija un nedaudz pielīdzināt izstrādes žurnālam, kad vietne pēdējoreiz strādāja.
- Noņemiet koda sadaļas, bet atstājiet tās pieejamas vēlākai lietošanai. To bieži veic vietnes testēšanas un atkļūdošanas laikā. Ja jums ir kāda problēma vietnē un neesat pārliecināts, kas to rada, varat komentēt sadaļas pa vienam, lai karantīnā atrastu problēmu, un pēc tam strādājiet pie problēmu risināšanas.
- Tērzējiet ar citiem koda izstrādātājiem. Tas, visticamāk, tiks darīts izstrādes laikā kā veids, kā vienlaikus dalīties ar informāciju ar citiem, kas strādā ar kodu. Ja šie komentāri ir tikai attīstības sarunas, labākā prakse ir tos noņemt no koda pirms vietnes palaišanas.
Tradicionāli HTML komentāri tiek izmantoti gandrīz jebkuram elementam, sākot no sarežģītu galda struktūru skaidrojumiem līdz informatīvām piezīmēm par paša lapas saturu. Tā kā pārlūka komentāri netiek noformēti, jūs varat tos pievienot jebkur HTML vietā un neuztraucas par to, ko darīs, kad klients to aplūkos.
Kā uzrakstīt komentārus
Komentāru rakstīšana HTML, XHTML un XML ir ļoti vienkārša. Vienkārši ieskaujiet tekstu, kuru vēlaties komentēt, izmantojot:
un ->Kā redzat, šie komentāri sākas ar "mazāk nekā simbolu", kā arī izsaukuma punktu un divām domām. Komentārs beidzas ar vēl divām domām un simbolu "lielāks par:". Starp šiem simboliem jūs varat rakstīt visu, ko vēlaties izteikt komentāra pamattekstā.
CSS, tas nedaudz atšķiras, izmantojot C koda komentārus, nevis HTML. Jūs sākat ar uz priekšu vērstu slīpsvītru, kam seko zvaigznīte. Jūs beidzat komentāru ar pretējo, zvaigznīti, kam seko priekšējā slīpsvītra.
/ * komentēja tekstu * /Komentāri ir Dying Art
Lielākā daļa programmētāju zina noderīgu komentāru vērtību. Komentēts kods atvieglo šo kodu no viena komandas dalībnieka uz citu. Komentāri palīdz QA komandai pārbaudīt kodu, jo viņi var pateikt, ko izstrādātājs paredzējis - pat ja tas nav sasniegts. Diemžēl ar vietņu autorēšanas platformu, piemēram, Wordpress, popularitāti, kas ļauj jums piecelties un darboties ar izvēlētu tēmu, kas daudz vai ne visai attiecas uz jums HTML, tīmekļa vietņu komandas bieži vien komentārus neizmanto. Tas ir tāpēc, ka vairumā vizuālo autorēšanas rīku komentārus tiešām ir grūti saskatīt, ja jūs nedarbojat tieši ar kodu. Piemēram, nevis redzēt tīmekļa lapas augšdaļā:
Vizuālais rīks parāda nelielu ikonu, kas norāda, ka komentārs ir tur. Ja dizaineris fiziski neatver komentāru, viņš nekad to nevar redzēt. Un iepriekš minētās lapas gadījumā tā var radīt problēmas, ja tā maina lapu un šī rediģēšana ir pārrakstīta komentārā minētā skriptā.
Ko var izdarīt?
- Uzrakstiet saturīgus un noderīgus komentārus. Negaidiet, ka citi cilvēki izlasīs jūsu komentārus, ja tie ir pārāk ilgi vai neietver noderīgu informāciju.
- Kā izstrādātājam vienmēr jāpārskata visi lapā redzamie komentāri.
- Izmantojiet autorēšanas programmu piedāvātos līdzekļus, kas ļauj jums pievienot komentārus.
- Izmantojiet satura pārvaldību, lai kontrolētu lapu rediģēšanu.
Pat ja jūs esat vienīgā persona, kas rediģē savas tīmekļa lapas, komentāri var būt noderīgi. Ja rediģējat sarežģītu lapu tikai vienu reizi gadā, ir viegli aizmirst, kā veidojāt galdu vai salikt CSS. Ar komentāriem jums nav jāatceras, jo tas ir tieši jums rakstīts.
Jennifera Krīnina oriģinālais raksts. Rediģējis Jeremijs Girards 5./5./17