Pareizi komentēts HTML marķējums ir būtiska labi izveidotas tīmekļa lapas sastāvdaļa. Šos komentārus ir viegli pievienot, un ikviens, kam nākotnē būs jāstrādā pie šīs vietnes koda (ieskaitot jūs vai jebkuras komandas locekļus, ar kuriem jūs strādājat), pateicos par šiem komentāriem.
Kā pievienot HTML komentārus
HTML var izveidot ar standarta teksta redaktoru, piemēram, Notepad ++ uz Windows vai TextEdit par Ma. Varat arī izmantot tīmekļa dizaina orientētu programmu, piemēram, Adobe Dreamweaver vai pat CMS platformu, piemēram, Wordpress vai ExpressionEngine. Neatkarīgi no rīka, kuru izmantojat, lai izveidotu HTML kodu, ja jūs strādājat tieši ar kodu, jūs pievienotu šādus HTML komentārus:
- Pievienojiet HTML komentāru taga pirmo daļu:
- Pēc šī komentāra atvēršanas raksta rakstiet jebkuru tekstu, kuru vēlaties redzēt šim komentāram. Iespējams, ka tas būs norādījumi jūsu vai kādam citam izstrādātājam nākotnē. Piemēram, ja vēlaties norādīt, kur sākas vai beidzas kāda lapas sadaļa lapā, varat izmantot komentāru, lai to detalizētu.
- Kad jūsu komentāra teksts ir pabeigts, aizveriet komentāru tagu šādi: ->
- Tātad kopumā jūsu komentārs izskatīsies šādi:
Komentāru rādīšana
Jebkurš komentārs, ko pievienojat savam HTML kodam, parādīsies šajā kodā, kad kāds skatīs tīmekļa lapas avotu vai atver HTML redaktoru, lai veiktu dažas izmaiņas. Tomēr šis komentāra teksts tīmekļa pārlūkprogrammā neparādīsies, kad parastās vietnes apmeklētāji ieradīsies vietnē. Atšķirībā no citiem HTML elementiem, ieskaitot punktus, virsrakstus vai sarakstus, kas faktiski ietekmē lapu šajās pārlūkprogrammās, komentāri patiešām ir lapas "aiz ainas".
Komentāri par testēšanas mērķiem
Tā kā komentāri neparādās tīmekļa pārlūkprogrammā, tos var izmantot, lai lapas izslēgtu lapas daļas testēšanas vai izstrādes laikā. Ja pievienojat komentāra sākuma daļu tieši pirms lapas / koda daļas, kuru vēlaties paslēpt, tad šī koda beigās jūs pievienojat noslēguma daļu (HTML komentāri var ietvert vairākas rindas, lai jūs varētu atvērt komentējiet savu koda 50. līniju un bez problēmām aizveriet to 75. līnijā), tad visi HTML komentāri, kas ietilpst šajā komentārā, vairs nebūs redzami pārlūkprogrammā. Tie paliks jūsu kodā, taču neietekmēs lapas vizuālo parādīšanu. Ja jums ir jāpārbauda lapa, lai uzzinātu, vai kāda sadaļa rada problēmas, utt, ieteicams komentēt šo apgabalu, lai to izdzēstu. Ar komentāriem, ja attiecīgā koda sadaļa nav problēma, jūs varat viegli noņemt komentāru gabalus un šis kods tiks parādīts vēlreiz. Tikai pārliecinieties, ka šie komentāri, kurus izmanto testēšanai, neveido to ražošanas vietnēs.
Ja lapas laukumu nevajadzētu attēlot, pirms vietnes palaišanas vēlaties noņemt kodu, nevis tikai komentēt.
Viena lieliska HTML komentāru izmantošana izstrādes laikā ir tad, ja veidojat atsaucīgu tīmekļa vietni . Tā kā šīs vietnes dažādās daļas mainīs savu izskatu, pamatojoties uz dažādiem ekrāna izmēriem , tostarp dažās jomās, kuras var netikt redzamas, izmantojiet komentārus, lai ieslēgtu vai izslēgtu lapas sadaļas, var būt ātrs un vienkāršs triks izstrādes laikā.
Attiecībā uz veiktspēju
Esmu redzējis dažus interneta profesionāļus, ka komentāri jāizņem no HTML un CSS failiem, lai sadalītu šo failu lielumu un izveidotu ātrākas ielādes lapas. Lai gan es piekrītu, ka lapas ir optimizētas veiktspējas veikšanai un tām ir jāielādē ātri, joprojām ir vieta, lai kodos ērti izmantotu komentārus. Ņemiet vērā, ka šie komentāri ir domāti, lai nākotnē tiktu vieglāk strādāt vietnē, tik ilgi, kamēr jūs to neaizkavēsit, pievienojot komentārus katrai koda rindai, neliels faila lielums, kas pievienots lapai sakarā ar komentāriem jābūt vairāk nekā pieņemamiem.
Padomi par komentāru izmantošanu
Dažas lietas, kas jāņem vērā vai jāatceras, izmantojot HTML komentārus:
- Komentāri var būt vairākas rindas.
- Izmantojiet komentārus, lai dokumentētu savas lapas izstrādi.
- Komentāri var al; lai dokumentētu saturu, tabulas rindas vai kolonnas, izsekotu izmaiņām vai neatkarīgi no jūsu vēlmēm.
- Komentāri par vietnes "izslēgšanu" nevajadzētu to ražot, ja vien šīs izmaiņas nav īslaicīgas, un tās tiks mainītas īsā laikā (piemēram, brīdī, kad nepieciešams, ieslēgts vai izslēgts brīdinājuma ziņojums).