Wat binne HTML-kommentaar en hoe wurde se brûkt
As jo in webside yn in blêdwizer sjen, sjogge jo in fisuele fertsjintwurdiging fan wat dat stik fan software (de webbrowser) op basis fan de koade fan in bepaalde webside sjen lit. As jo de boarne koade fan 'e webside besjen, sille jo in dokumint sjen fan ferskate HTML-eleminten, ynklusyf paragrafen, kopteksten, listen, keppels, ôfbyldings en mear. Alle fan dizze eleminten wurde troch de blêder op in skermbefeiliging makke as part fan it display fan de webside. Ien ding dat jo fine kinne yn HTML-koade dat net op in skerm fan in persoan makke wurdt binne wat bekend as "HTML-kommentaar".
Wat is in kommentaar?
In kommentaar is in string fan koade yn HTML, XML, of CSS dy't net troch de blêder of parser besjoen wurdt. It is ienfâldich yn de koade skreaun om ynformaasje oer dizze koade te jaan of in oare feedback fan de koadeûntwikkelders.
De measte programmearringen hawwe kommentaren, dy wurde faak brûkt troch de ûntwikkelders fan de koade foar ien of mear as ien, fan 'e folgjende reden:
- Besykje en komplisearre koade te ferklearjen foar immen dy't miskien yn 'e takomst dwaende moat - ynklusyf harsels! Se kinne weromkomme op 3 of 6 fan 12 moannen of mear später en ûnthâld net wêrom't se wat op in beskate manier dwaan. Kommentaar kin helpe tegearre te beantwurdzjen op har fraach en rapportearjen wêr't har tinzen binne doe't se earst dizze side ûntwikkele.
- Soargje details oer wannear't de koade bewurke of besprutsen waard. Dit kin brûkbere ynformaasje en dogge wat as in ûntwikkeling hokker as in side de lêste wurke wie.
- Ofdielingen fan 'e koade fuortsmite, mar litte se beskikke foar spesjale gebrûk. Dit wurdt faak dien as teste en debuggen. As jo in probleem hawwe op in side en binne net wis wêr't it feroarsake kinst, kinne jo ien fan in kear opnimme om quartintine út te kommentearjen en it probleem te identifisearjen, en wurkje dan op in beheining foar hokker problemen jo hawwe.
- Chat mei oare ûntwikkelers dy't wurkje oan de koade. Dit soe wierskynlik dien wurde yn 'e ûntwikkeling as in manier om details te dielen mei oaren dy't wurkje op' e koade tagelyk. As dizze opmerkingen gewoante ûntwikkeling konversaasjes binne, is it in bêste praktyk om se te foarkommen fan 'e koade foardat in side begon is.
Tradysjoneel wurde kommentaren yn HTML brûkt foar elke eleminten, fan útlis fan komplekse tabelstruktueren nei ynformative oanmerkingen fan de ynhâld fan 'e side sels. Om't kommentaren net yn in blêder rendeard binne, kinne jo se oeral yn it HTML tafoegje en hawwe gjin soargen oer wat it sil dwaan as de side troch in klant besjoen wurdt.
Hoe kommentaar opskriuwe
Skriuwen kommentaar yn HTML, XHTML, en XML is hiel maklik. Skep de tekst dy't jo wolle kommentearje mei de neikommende:
en ->As jo sjogge, begjinne dizze opmerkingen mei in "minder dan symboal", plus in oproppepunt en twa stringen. It kommentaar is útein mei twa oare strigels en in "grutter as symboal". Tusken dizze personaazjes kinne jo skriuwe wat jo it lichem fan 'e kommentaar meitsje wolle.
Yn CSS is it in bytsje oars, mei help fan C-koade opmerkingen ynstee fan HTML Jo begjinne mei in trochslach troch in asterisk folge. Jo beäntwurdzje de kommentaar mei de invers fan dat, in asterisk folge troch in foarsprong.
/ * kommentearre tekst * /Kommentaar binne in Dying Art
De measte programmers kenne de wearde fan brûkte kommentaren . Komeedzje fan 'e kommentaar makket it makliker dat dizze koade fan ien team lid is nei in oar. Kommentaar helpe jo QA-ploech om de koade te testen, om't se fertelle kinne wat de ûntwikkelders bedoeld binne - sels as it net berikt waard. Spitigernôch, mei de populaasje fan webstekstribbavingen lykas Wordpress, dy't jo stean en rinne kinne mei in keazen tema dy't in soad, as net allegearre, fan 'e HTML foar jo, kommentaren net sa faak brûkt wurde troch webteams. Dit is om't de opmerkingen echt heul binne te sjen yn de measte fisuele helpmiddels as jo net direkt mei de koade wurkje. Sa kinne bygelyks net sjen, oan 'e top fan in webside:
It fisuele ark lit sjen in lyts byldkaike om oan te jaan dat in kommintaar der is. As de ûntwerper de kommentaar net fyslik iepenet, kin er it nea sjen. En yn it gefal fan de hjirboppe side, kinne problemen feroarsaakje as se de side bewurkest en dat bewurking is oer-skreaun troch it skript dat neamd wurdt yn 'e kommentaar.
Wat kin dien wurde?
- Skriuw sinjale en brûkte kommentaar. Ferwachtsje net oare minsken om jo kommentaar te lêzen as se te lang binne of net nuttige ynformaasje opnimme.
- As ûntwikkelder moatte jo altyd alle reaksjes opnimme dy't jo sjogge op in side.
- Brûk tools dy't levere wurde troch de auteursprogramma's dy't jo kinne opmerkings taheakje.
- Brûk ynhâldbehear om te kontrolearjen hoe't de siden werjûn wurde.
Sels as jo de ienige persoan dy't jo websteeën feroaret, kinne jo kommentaar brûke. As jo ien inkele jiertallen allinich in komplisearre side bewurkje, dan is it maklik te ferjitten hoe't jo de tabel bouden of de CSS ferienigje. Mei kommentaren, moatte jo net oanpasse, as it dêr foar jo skreaun is.
Oarspronklik artikel fan Jennifer Krynin. Edited by Jeremy Girard on 5/5/17