Hoe om kommentaar in jou HTML te voeg

Behoorlik kommentaar op HTML-opmaak is 'n belangrike deel van 'n goed-gebou webblad. Daardie kommentaar is maklik om by te voeg, en iemand wat in die toekoms op die werf se kode moet werk (insluitend jouself of lede van enige span waarmee jy werk) sal dankie sê vir die kommentaar.

Hoe om HTML-opmerkings by te voeg

HTML kan geskryf word met 'n standaard teksredakteur, soos Notepad + + vir Windows of TextEdit vir 'n Ma. U kan ook 'n webdesign-sentriese program soos Adobe Dreamweaver of selfs 'n CMS-platform soos Wordpress of ExpressionEngine gebruik. Ongeag van die instrument wat jy gebruik vir outeur HTML, as jy direk met die kode werk, sal jy HTML-kommentaar soos volg byvoeg:

  1. Voeg die eerste deel van die HTML-kommentaar tag toe:
  2. Na die opening van die kommentaar, skryf enige teks wat u graag vir hierdie kommentaar wil verskyn. Dit is waarskynlik instruksies vir u of 'n ander ontwikkelaar in die toekoms. As u byvoorbeeld wil aanwys waar 'n sekere afdeling op 'n bladsy begin of eindig in die opmerkings, kan u 'n opmerking oor detail gebruik.
  3. Sodra die teks van jou kommentaar voltooi is, maak die kommentaar-tag soos volg: ->
  4. So in totaal sal jou kommentaar so lyk:

Die vertoning van kommentaar

Enige kommentaar wat jy by jou HTML-kode voeg, sal in daardie kode verskyn wanneer iemand die bron van die webblad sien of die HTML in 'n redigeerder oopmaak om 'n paar veranderinge te maak. Die kommentaar teks sal egter nie in die webblaaier verskyn wanneer 'n normale besoeker na die webwerf kom nie. In teenstelling met ander HTML-elemente, insluitend paragrawe, opskrifte of lyste, wat die bladsy binne die blaaiers beïnvloed, is kommentaar regtig "agter die skerms" van die bladsy.

Kommentaar vir Toetsdoeleindes

Aangesien opmerkings nie in 'n webblaaier verskyn nie, kan hulle gebruik word om dele van 'n bladsy af te skakel tydens die toets of ontwikkeling van die bladsy. As jy die oop gedeelte van 'n opmerking direk voor die deel van jou bladsy / kode wat jy wil wegsteek, byvoeg, en dan voeg jy die sluitingsdeel aan die einde van die kode by (HTML-kommentaar kan oor meerdere lyne strek, sodat jy 'n kommentaar lewer op reël 50 van jou kode en sluit dit op lyn 75 sonder probleme), dan sal enige HTML-elemente wat binne daardie kommentaar val, nie meer in die blaaier vertoon word nie. Hulle sal in u kode bly, maar sal nie die visuele vertoning van die bladsy beïnvloed nie. As jy 'n bladsy moet toets om te sien of 'n sekere afdeling probleme veroorsaak, ens., Is dit beter om dit uit te voer. Met kommentaar, as die betrokke kodekode nie die probleem is nie, kan jy die kommentaarstukke maklik verwyder en daardie kode sal weer vertoon word. Wees maar seker dat hierdie kommentaar wat gebruik word vir toetsing, nie in produksiewebwerwe maak nie.

As 'n gedeelte van 'n bladsy nie vertoon moet word nie, wil jy die kode verwyder, nie net kommentaar lewer nie, voordat jy die webwerf begin.

Een groot gebruik van HTML-opmerkings tydens die ontwikkeling is wanneer jy ' n responsiewe webwerf bou . Omdat verskillende dele van die werf hul voorkoms sal verander op grond van verskillende skermgroottes , insluitende sommige gebiede wat glad nie vertoon kan word nie, kan die gebruik van kommentaar om gedeeltes van 'n bladsy aan of af te skakel, 'n vinnige en maklike truuk wees om tydens ontwikkeling te gebruik.

Ten opsigte van prestasie

Ek het gesien dat sommige webprofessionale daarop dui dat kommentaar gestroop moet word van HTML- en CSS-lêers om die grootte van daardie lêers te skeer en vinniger laai-bladsye te skep. Alhoewel ek dit eens is dat bladsye vir prestasie geoptimaliseer moet word en vinnig moet laai, is daar nog 'n plek vir die slim gebruik van kommentaar in kode. Onthou, hierdie kommentaar is bedoel om dit makliker te maak om in die toekoms op 'n werf te werk. So lank as wat jy nie agterstallig is met kommentaar wat by elke lyn in jou kode gevoeg word nie, word die klein hoeveelheid lêergrootte bygevoeg aan 'n bladsy as gevolg van Kommentaar moet meer as aanvaarbaar wees.

Wenke vir die gebruik van kommentaar

'N Paar dinge om te onthou of onthou wanneer jy HTML-kommentaar gebruik:

  1. Kommentaar kan verskeie lyne wees.
  2. Gebruik kommentaar om u bladsy se ontwikkeling te dokumenteer.
  3. Kommentaar kan al; so dokument inhoud, tabel rye of kolomme, spoor veranderinge of wat jy wil.
  4. Kommentaar dat 'n afskakelarea van 'n perseel nie in produksie moet word nie, tensy hierdie verandering 'n tydelike een is wat in kort volgorde omgekeer sal word (soos om 'n waarskuwingsboodskap aan of af te skakel soos benodig).