Beth yw HTML Sylwadau a Sut maent yn Defnyddio
a Pan fyddwch chi'n gweld tudalen we mewn porwr, rydych chi'n gweld cynrychiolaeth weledol o'r hyn y mae'r meddalwedd hwnnw (y porwr gwe) yn ei arddangos yn seiliedig ar god tudalen we benodol. Os ydych chi'n gweld cod ffynhonnell y dudalen we, fe welwch ddogfen sy'n cynnwys elfennau HTML amrywiol, gan gynnwys paragraffau, penawdau, rhestrau, dolenni, delweddau a mwy. Mae'r holl elfennau hyn yn cael eu rendro gan y porwr ar sgrin ymwelwyr fel rhan o arddangosiad y wefan. Un peth y gallwch ddod o hyd i chi mewn cod HTML nad yw'n cael ei rendro ar sgrin unigolyn yw'r hyn a elwir yn "sylwadau HTML".
Beth yw Sylw?
Mae sylw yn gyfres o god o fewn HTML, XML, neu CSS nad yw'r porwr neu'r parser yn ei weld neu sy'n gweithredu arno. Fe'i hysgrifennir yn y cod yn syml i ddarparu gwybodaeth am y cod hwnnw neu adborth arall gan ddatblygwyr y cod.
Mae gan y mwyafrif o ieithoedd rhaglennu sylwadau, fe'u defnyddir yn aml gan ddatblygwr y cod ar gyfer un neu hyd yn oed mwy nag un, o'r rheswm canlynol:
- Disgrifiwch ac esboniwch god cymhleth i rywun a allai orfod gweithio arno yn y dyfodol - gan gynnwys eu hunain! Efallai y byddant yn dychwelyd i'r cod 3 neu 6 o 12 mis neu fwy yn ddiweddarach ac nid ydynt yn cofio pam eu bod yn gwneud rhywbeth yn rhywbeth penodol. Gall sylwadau helpu i ateb eu cwestiynau a'u hatgoffa o le oedd eu meddwl pan oeddent yn datblygu'r dudalen honno'n gyntaf.
- Rhowch fanylion ynghylch pryd y golygwyd neu a adolygwyd y cod. Gall hyn fod yn wybodaeth ddefnyddiol a gweithredu rhywfaint fel cofnod datblygu o bryd y cafodd safle ei weithio ddiwethaf.
- Dileu rhannau o'r cod, ond eu gadael ar gael i'w defnyddio'n hwyrach. Gwneir hyn yn aml yn ystod profion safle a dadfeddiannu. Os oes problem gennych ar y safle ac nad ydych yn siŵr beth sy'n ei achosi, gallwch chi roi sylw i adrannau un ar y tro i questiniaeth a nodi'r mater, ac yna gweithio ar brawf ar gyfer pa broblemau bynnag yr ydych yn eu cael.
- Sgwrsio gyda datblygwyr eraill sy'n gweithio ar y cod. Byddai hyn yn debygol o gael ei wneud yn ystod y datblygiad fel ffordd o rannu manylion gydag eraill sy'n gweithio ar y cod ar yr un pryd. Os mai dim ond sgyrsiau datblygu yw'r sylwadau hyn, mae'n arfer gorau i'w symud o'r cod cyn i safle gael ei lansio.
Yn draddodiadol, defnyddir sylwadau yn HTML ar gyfer bron unrhyw elfennau, o esboniadau o strwythurau tabl cymhleth i sylwadau hysbysiadol o gynnwys y dudalen ei hun. Gan nad yw sylwadau wedi'u rendro mewn porwr, gallwch eu hychwanegu yn unrhyw le yn yr HTML ac nid oes ganddynt unrhyw bryderon ynglŷn â beth fydd yn ei wneud pan fydd cwsmer yn edrych ar y safle.
Sut i Ysgrifennu Sylwadau
Mae sylwadau ysgrifennu yn HTML, XHTML, ac XML yn hawdd iawn. Yn syml, cwmpaswch y testun yr ydych am ei ddweud wrth y canlynol:
a ->Fel y gwelwch, mae'r sylwadau hyn yn dechrau gyda "llai na symbolau", ynghyd â phwynt gogwydd a dau dashes. Mae'r sylw'n dod i ben gyda dau dashes mwy a symbolau "mwy na: Rhwng y cymeriadau hynny gallwch chi chi ysgrifennu beth bynnag yr ydych am wneud corff y sylw.
Yn CSS, mae'n ychydig yn wahanol, gan ddefnyddio sylwadau cod C yn hytrach na HTML Rydych yn dechrau gyda slash ymlaen ac yna seren. Rydych chi'n gorffen y sylw gyda'r gwrthdro hwnnw, seren ac yna slash ymlaen.
/ * sylw testun * /Mae'r Sylwadau'n Gelfyddyd Marwol
Mae'r mwyafrif o raglenwyr yn gwybod gwerth sylwadau defnyddiol . Mae'r cod a ddywedwyd yn ei gwneud hi'n haws i'r cod hwnnw gael ei drosglwyddo o un aelod o'r tîm i'r llall. Mae'r sylwadau'n eich helpu chi i QA tîm i brofi'r cod, oherwydd gallant ddweud beth a fwriadwyd gan y datblygwr - hyd yn oed os na chafodd ei gyflawni. Yn anffodus, gyda phoblogrwydd llwyfannau awdurdodi gwefannau fel Wordpress, sy'n eich galluogi i fynychu gyda thema a ddewisir sy'n delio â llawer o'r HTML ar eich cyfer chi, ni ddefnyddir timau gwe yn aml. Mae hyn oherwydd bod y sylwadau'n anodd iawn eu gweld yn y rhan fwyaf o offer awdur gweledol os nad ydych chi'n gweithio'n uniongyrchol gyda'r cod. Er enghraifft, yn hytrach na gweld, ar frig gwefan:
Mae'r offeryn gweledol yn dangos eicon fach i ddangos bod sylw yno. Os na fydd y dylunydd yn agor y sylw yn gorfforol, ni all byth ei weld. Ac yn achos y dudalen uchod, gallai achosi problemau os bydd hi'n golygu'r dudalen ac mae'r golygu'n cael ei or-ysgrifennu gan y sgript a grybwyllir yn y sylw.
Beth y gellir ei wneud?
- Ysgrifennwch sylwadau ystyrlon a defnyddiol. Peidiwch â disgwyl i bobl eraill ddarllen eich sylwadau os ydynt yn rhy hir neu os nad ydych yn cynnwys gwybodaeth ddefnyddiol.
- Fel datblygwr, dylech bob amser adolygu unrhyw sylwadau a welwch ar dudalen.
- Defnyddiwch offer a ddarperir gan y rhaglenni awdur sy'n eich galluogi i ychwanegu sylwadau.
- Defnyddiwch reoli cynnwys i reoli sut mae'r tudalennau'n cael eu golygu.
Hyd yn oed os mai chi yw'r unig berson sy'n golygu eich tudalennau gwe, gall sylwadau fod yn ddefnyddiol. Os mai dim ond tudalen gymhleth yr ydych yn ei olygu unwaith y flwyddyn, mae'n hawdd anghofio sut yr ydych wedi adeiladu'r bwrdd neu wedi llunio'r CSS. Gyda sylwadau, nid oes rhaid i chi gofio, gan ei bod wedi ei ysgrifennu ar y pryd ar eich cyfer chi.
Erthygl wreiddiol gan Jennifer Krynin. Golygwyd gan Jeremy Girard ar 5/5/17