Mis on HTML-i kommentaarid ja kuidas neid kasutatakse
a Kui vaatate brauseris veebilehte, näete nägemist, milline see tarkvara (veebibrauser) kuvatakse konkreetse veebilehe koodi alusel. Kui näete veebilehe lähtekoodi , näed te dokumenti, mis koosneb erinevatest HTML-elementidest, sealhulgas lõigetest, rubriikidest, loenditest, linkidest, piltidest jms. Kõik need elemendid on veebisaidi kuvamise osana külastaja ekraani brauser. Üks asi, mida võite leida HTML-koodi, mida ei kuvata inimese ekraanil, on need, mida nimetatakse "HTML-kommentaarideks".
Mis on kommentaar?
Kommentaariks on HTML-i, XML-i või CSS-i koodide string, mida brauser ja parser ei näe ega käidelda. See on lihtsalt koodi sisestatud, et anda teavet selle koodi või muu koodi arendaja tagasiside kohta.
Enamikul programmeerimiskeeledel on kommentaarid, mida koodi arendaja kasutab tavaliselt üht või enamat järgmistest põhjustest:
- Kirjeldage ja selgitage keerukat koodi sellele, kellel võib tulevikus tööd teha, kaasa arvatud ise! Nad võivad tagasi pöörduda tagasi koodi 3 või 6-ni alates 12-kuulisest või uuemast hilisemast kuupäevast, ega mäleta, miks nad tegi midagi teatud viisil. Kommentaarid aitavad vastata nendele küsimustele ja tuletavad neile meelde, kus nende meel oli, kui nad seda lehte esmakordselt arendasid.
- Esitage üksikasjad koodi redigeerimise või läbivaatamise kohta. See võib olla kasulik teave ja toimida mõnevõrra sarnaselt arengupäevikuga, kui saiti viimati töötas.
- Eemaldage koodi sektsioonid, kuid jäta need hiljem kasutamiseks kättesaadavaks. Seda tehakse tihti saidi testimise ja silumise ajal. Kui teil on saidil probleem ja te pole kindel, mis seda põhjustab, saate kommenteerida lõigud ükshaaval, et karantiini määrata ja probleemi tuvastada, ja seejärel töötada probleemide lahendamiseks, mis teil on.
- Vestlege teiste koodiga töötavate arendajatega. Seda tehakse arenduse käigus tõenäoliselt selleks, et jagada andmeid teiste koodidega töötavatega samal ajal. Kui need kommentaarid on puhtalt arendusvideod, on parim viis eemaldada need koodist enne saidi käivitamist.
Traditsiooniliselt kasutatakse HTML-i kommentaarides peaaegu kõiki elemente, alates keeruliste tabelistrukumentide selgitustest kuni lehe sisu informatiivsete märkuste juurde. Kuna kommentaare brauseris ei esitata, võite neid lisada HTML-i kõikjal ja ei pea muretsema, mida ta teeb, kui klient seda saiti vaatab.
Kuidas kirjutada kommentaare
Kommentaaride kirjutamine HTML-i, XHTML-i ja XML-i on väga lihtne. Lihtsalt ümbritsege soovitud tekst kommenteeritud järgmisega:
ja ->Nagu näete, algavad need kommentaarid "vähem kui sümboliga", pluss väljaheitepunkt ja kaks kriipsu. Kommentaar lõpeb veel kahe kriipsuga ja sümboliga "suurem kui:". Nende märkide vahel saate kirjutada kõik, mida soovite kommenteerida.
CSS-is on see natuke erinev, kasutades pigem C-koodi kommentaare kui HTML-d. Alustades kaldkriipsuga, millele järgneb tärn. Lõpute kommenteerimise selle tagurpidi, tärniga, millele järgneb kaldkriips.
/ * kommenteeritud tekst * /Kommentaarid on Dying Art
Enamik programmeerijaid teab kasulike kommentaaride väärtust. Kommenteeritava koodi abil on lihtsam selle koodi ülekandmine ühest meeskonnaliikmest teise. Kommentaarid aitavad QA meeskonnal koodi testida, sest nad saavad öelda, mida arendaja soovis, isegi kui seda ei saavutata. Kahjuks veebipõhiste veebisaidi loomise platvormide, nagu Wordpress, populaarsus, mis võimaldab teil käivituda ja käivitada valitud teema, mis käitleb suvaliselt HTML-i teie jaoks, ei tee veebimänge sageli kommenteerimisi. Selle põhjuseks on asjaolu, et enamikes visuaalsete autorite tööriistades on märkusi tõesti raske näha, kui te ei tööta koodiga otse. Näiteks veebilehe ülaosas asemel näeme:
Visuaalne tööriist näitab väikest ikooni, mis näitab, et kommentaar on olemas. Kui disainer ei ilmu kommentaari füüsiliselt, ei pruugi ta seda kunagi näha. Eespool toodud lehe puhul võib see põhjustada probleeme, kui ta lehte redigeerib ja kommentaaris mainitud skript on üle redigeerinud.
Mida saaks teha?
- Kirjutage sisukaid ja kasulikke kommentaare. Ärge oodake, et teised inimesed saaksid teie kommentaare lugeda, kui need on liiga pikad või ei sisalda kasulikku teavet.
- Arendajatena peaksite alati vaatama kõik lehel olevad kommentaarid.
- Kasutage rakendusprogramme, mis võimaldavad teil lisada kommentaare.
- Kasutage sisuhaldust, et kontrollida, kuidas lehti redigeeritakse.
Isegi kui olete ainus isik, kes muudab teie veebisaite, võib kommenteerimine olla kasulik. Kui redigeerite ainult keerulist lehte kord aastas, on lihtne unustada, kuidas tabelit koostatud või CSS-i kokku panna. Kommentaaridega ei pea meeles pidama, sest see on teie jaoks õige koht.
Jennifer Krynini algne artikkel. Redigeeris Jeremy Girard 5./5/17