Pareizi komentēts HTML iezīmēšana ir svarīga 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 pats vai jebkuras komandas locekļus, ar kuriem strādājat), pateiks jums par šiem komentāriem.
Kā pievienot HTML komentārus
HTML var izveidot ar standarta teksta redaktoru, piemēram, Notepad ++ operētājsistēmai Windows vai TextEdit Mac datoram. Varat arī izmantot tādu Web dizaina programmu kā Adobe Dreamweaver vai pat CMS platformu, piemēram, Wordpress vai ExpressionEngine. Neatkarīgi no rīka, kuru izmantojat HTML izveidošanai, ja strādājat tieši ar kodu, jūs pievienojat šādus HTML komentārus:
Pievienojiet HTML komentāru taga pirmo daļu:
Pēc šī komentāra sākuma daļas uzrakstiet tekstu, kuru vēlaties parādīt šim komentāram. Iespējams, ka tie nākotnē būs jūsu vai cita izstrādātāja norādījumi. Piemēram, ja vēlaties norādīt, kur noteikta sadaļa lapā sākas vai beidzas ar marķējumu, varat detalizēti izmantot komentāru.
Kad komentāra teksts ir pabeigts, aizveriet komentāru tagu šādi:
Tātad kopumā jūsu komentārs izskatīsies apmēram šādi:
Tas tiešām ir tik vienkārši.
Komentāru parādīšana
Visi komentāri, ko pievienojat savam HTML kodam, tiks parādīti tajā, kad kāds skata Web lapas avotu vai redaktorā atver HTML, lai veiktu dažas izmaiņas. Šis komentāra teksts tomēr neparādīsies tīmekļa pārlūkprogrammā, kad vietnē ierodas normāli apmeklētāji. Atšķirībā no citiem HTML elementiem, ieskaitot rindkopas, virsrakstus vai sarakstus, kas faktiski ietekmē lapu šajās pārlūkprogrammās, komentāri patiešām ir lapas aizkulises.
Komentāri pārbaudes vajadzībām
Tā kā komentāri neparādās tīmekļa pārlūkprogrammā, tos var izmantot, lai "izslēgtu" lapas daļas lapas testēšanas vai izstrādes laikā. Ja pievienojat komentāra sākuma daļu tieši pirms savas lapas / koda daļas, kuru vēlaties paslēpt, un pēc tam pievienojat noslēdzošā daļa šī koda beigās (HTML komentāri var ietvert vairākas rindas, tāpēc jūs varat atvērt komentāru sava koda teiksmajai 50. rindiņai un aizveriet to 75. rindā bez problēmām), tad visi HTML elementi, kas ietilpst šajā komentārā, vairs netiks parādīti pārlūku. Tie paliks jūsu kodā, bet neietekmēs lapas vizuālo attēlojumu. Ja jums jāpārbauda lapa, lai pārliecinātos, vai kāda sadaļa rada problēmas utt., Vēlams komentēt šo apgabalu ārpus tā dzēšanas. Izmantojot komentārus, ja izrādās, ka attiecīgā koda sadaļa nav problēma, varat viegli noņemt komentāru fragmentus, un šis kods tiks parādīts vēlreiz. Vienkārši pārliecinieties, ka šie komentāri, kas tiek izmantoti testēšanai, nenonāk ražošanas vietnēs. Ja lapas apgabals nav jāparāda, pirms šīs vietnes palaišanas vēlaties kodu noņemt, nevis vienkārši komentēt.
Viens lielisks HTML komentāru izmantojums izstrādes laikā ir tas, kad jūs veidojat atsaucīga vietne. Tā kā dažādas šīs vietnes daļas mainīs savu izskatu, pamatojoties uz dažādi ekrāna izmēri, ieskaitot dažus apgabalus, kuri, iespējams, netiek parādīti vispār, komentāru izmantošana, lai ieslēgtu vai izslēgtu lapas sadaļas, var būt ātrs un ērts triks, ko izmantot izstrādes laikā.
Attiecībā uz sniegumu
Esmu redzējis, ka daži tīmekļa profesionāļi iesaka komentārus noņemt no HTML un CSS failiem, lai samazinātu šo failu lielumu un izveidotu ātrāk ielādējamas lapas. Lai gan es piekrītu, ka lapām jābūt optimizēts veiktspējai un tai vajadzētu ātri ielādēt, joprojām ir vieta viedai komentāru izmantošanai kodā. Atcerieties, ka šie komentāri ir domāti, lai nākotnē būtu vieglāk strādāt vietnē, tāpēc, kamēr jūs to nepārspīlējat komentāriem, kas pievienoti katrai jūsu koda rindiņai, nelielam faila lielumam, kas lapai pievienots komentāru dēļ, jābūt lielākam par pieņemams.
Padomi komentāru izmantošanai
Dažas lietas, kas jāņem vērā vai jāatceras, lietojot HTML komentārus:
- Komentāri var būt vairākas rindas.
- Izmantojiet komentārus, lai dokumentētu savas lapas attīstību.
- Komentāri var arī dokumentēt saturu, tabulas rindas vai kolonnas, izsekot izmaiņas vai visu, ko vēlaties.
- Komentāri, kas "izslēdz" vietnes teritorijas, nedrīkst to padarīt par ražošanu, ja vien šīs izmaiņas nav a pagaidu, kas tiks mainīts īsā secībā (piemēram, brīdinājuma ziņa ieslēgšana vai izslēgšana kā nepieciešams).