Athugasemdir við athugasemdir

Hvað eru HTML athugasemdir og hvernig eru þau notuð

a Þegar þú skoðar vefsíðu í vafra erðu að sjá sjónræna framsetningu af því hvaða hugbúnaður (vefskoðarinn) er að sýna á grundvelli kóðans á tilteknu vefsíðu. Ef þú skoðar þessa kóðann á vefsíðunni birtir þú skjal sem samanstendur af ýmsum HTML-þætti, þ.mt málsgreinar, fyrirsagnir, listi, tengla, myndir og fleira. Öll þessi þættir eru sýndar af vafranum á skjánum sem gestur er hluti af skjánum á vefsíðunni. Eitt sem þú finnur í HTML kóða sem ekki er sýnt á skjánum er það sem kallast "HTML athugasemdir".

Hvað er athugasemd?

Athugasemd er strengur kóða innan HTML, XML eða CSS sem ekki er skoðað eða virkað af vafranum eða flokkaþáttinum. Það er einfaldlega skrifað inn í kóðann til að veita upplýsingar um þennan kóða eða aðrar athugasemdir frá kóðanum.

Flest forritunarmál hafa athugasemdir, þau eru almennt notuð af forritara kóðans fyrir einn eða jafnvel fleiri en einn af eftirfarandi ástæðu:

• Lýsið og útskýrðu flókið kóða til einhvern sem getur þurft að vinna með það í framtíðinni - þar með talið sjálfir! Þeir geta komið aftur til kóða 3 eða 6 af 12 mánuðum eða síðar og man ekki eftir því hvers vegna þeir gerðu eitthvað á vissan hátt. Athugasemdir geta hjálpað til við að svara spurningum sínum og minna þá á hvar hugurinn þeirra var þegar þeir voru að þróa fyrstu síðu.
• Gefðu upplýsingar um hvenær númerið var breytt eða skoðað. Þetta getur verið gagnlegt og gerist nokkuð eins og þróunarlisti hvenær síða var síðast unnið.
• Fjarlægðu köflum kóðans, en láttu þau vera tiltæk til notkunar síðar. Þetta er oft gert við prófanir á staðnum og kembiforrit. Ef þú átt í vandræðum á vefsvæðinu og er ekki viss um hvað er að valda því getur þú skrifað ummæli um hlutar einn í einu til að greina frá því og greina vandamálið og vinna síðan úrlausn fyrir hvaða vandamál sem þú ert með.
• Spjallaðu við aðra forritara sem vinna á kóðann. Þetta er líklega gert á meðan þróun stendur sem leið til að deila upplýsingum með öðrum sem vinna að kóðanum á sama tíma. Ef þessar athugasemdir eru eingöngu þróunarsamtal, er best að fjarlægja þau úr kóðanum áður en síða er hleypt af stokkunum.

Hefð er að athugasemdir í HTML eru notaðar fyrir næstum hvaða þætti, frá skýringum á flóknum borðum í uppbyggingu til upplýsandi athugasemda um innihald síðunnar sjálfs. Þar sem athugasemdir eru ekki gerðar í vafra getur þú bætt þeim hvar sem er í HTML og ekki áhyggjur af því hvað það mun gera þegar síða er skoðað af viðskiptavini.

Hvernig á að skrifa athugasemdir

Að skrifa athugasemdir í HTML, XHTML og XML er mjög auðvelt. Umkringdu einfaldlega textann sem þú vilt hafa athugasemdir við með eftirfarandi:

og

->

Eins og þú getur séð, byrja þessar athugasemdir með "minna en tákn", auk útprentunar og tveggja punkta. Athugasemdin endar með tveimur strikum og "stærri en: tákninu". Milli þessara stafa er hægt að skrifa hvað sem þú vilt gera í líkamanum.

Í CSS, það er svolítið öðruvísi með því að nota C-kóða athugasemdir frekar en HTML. Þú byrjar með áframsenda rista eftir stjörnu. Þú endar athugasemdina með andhverri því, stjörnu eftir og framsenda rista.

/ * skrifað texti * /

Athugasemdir eru Dying Art

Flestir forritarar þekkja gildi gagnlegra athugasemda . Athugasemdarkóði gerir það auðveldara að þessi kóða sé flutt frá einum meðlimi til annars. Athugasemdir hjálpa þér QA lið til að prófa kóðann, vegna þess að þeir geta sagt hvað verktaki ætlaði - jafnvel þótt það væri ekki náð. Því miður, með vinsældum vefsíðnaforrita eins og Wordpress, sem gerir þér kleift að komast í gang með valið þema sem annast mikið, ef ekki allt, af HTML fyrir þig, eru athugasemdir ekki notuð eins oft af vefsteymum. Þetta er vegna þess að athugasemdirnar eru mjög erfitt að sjá í flestum sjónrænum höfundarverkfærum ef þú ert ekki að vinna beint við kóðann. Til dæmis, frekar en að sjá, efst á vefsíðu:

Sýnatækið sýnir örlítið tákn til að gefa til kynna að ummæli séu til staðar. Ef hönnuður ekki opnar athugasemdina líkamlega, getur hann aldrei séð það. Og ef um er að ræða ofangreindan síðu gæti það valdið vandræðum ef hún breytir síðunni og að útgáfa er yfirskrifuð af handritinu sem nefnt er í ummælunum.

Hvað er hægt að gera?

1. Skrifaðu umtalsverðar og gagnlegar athugasemdir. Ekki búast við öðru fólki að lesa athugasemdir þínar ef þau eru of löng eða innihalda ekki gagnlegar upplýsingar.
2. Sem verktaki ættir þú alltaf að endurskoða athugasemdir sem þú sérð á síðu.
3. Notaðu verkfæri sem höfundarforritin bjóða upp á, sem gerir þér kleift að bæta við athugasemdum.
4. Notaðu efnisstjórnun til að stjórna hvernig síðurnar eru breyttar.

Jafnvel ef þú ert sá eini sem breytir vefsíðum þínum, geta athugasemdir verið gagnlegar. Ef þú breytir aðeins flóknu síðu einu sinni á ári, er auðvelt að gleyma því hvernig þú hefur byggt upp borðið eða sett saman CSS. Með athugasemdum þarftu ekki að muna, eins og það er skrifað þarna fyrir þig.

Upprunaleg grein af Jennifer Krynin. Breytt af Jeremy Girard á 5/5/17