Wat is HTML-opmerkings en hoe word dit gebruik
a Wanneer u 'n webblad in 'n blaaier bekyk, sien u 'n visuele voorstelling van wat daardie programmatuur (die webblaaier) vertoon, gebaseer op die kode van 'n bepaalde webblad. As u die bronkode van die webblad bekyk , sal u 'n dokument sien wat bestaan uit verskeie HTML-elemente, insluitend paragrawe, opskrifte, lyste, skakels, prente en meer. Al hierdie elemente word deur die blaaier op 'n besoekersskerm vertoon as deel van die vertoning van die webwerf. Een ding wat u kan vind in HTML-kode wat nie op 'n persoon se skerm verskyn nie, is wat bekend staan as "HTML-opmerkings".
Wat is 'n opmerking?
'N Kommentaar is 'n string kode binne HTML, XML of CSS wat nie deur die blaaier of parser besigtig of opgetree word nie. Dit word eenvoudig in die kode geskryf om inligting oor die kode of ander terugvoer van die kode ontwikkelaars te verskaf.
Die meeste programmeertale het kommentaar, hulle word algemeen gebruik deur die kode se ontwikkelaar vir een of selfs meer as een van die volgende redes:
- Beskryf en verduidelik ingewikkelde kode vir iemand wat dalk in die toekoms daaraan moet werk - insluitend hulself! Hulle kan terugkeer na kode 3 of 6 van 12 maande of meer later en nie onthou hoekom hulle iets op 'n sekere manier gedoen het nie. Opmerkings kan help om hul vrae te beantwoord en hulle te herinner aan waar hul verstand was toe hulle die eerste keer die bladsy ontwikkel het.
- Verskaf besonderhede oor wanneer die kode geredigeer of hersien is. Dit kan nuttige inligting wees en handel soos 'n ontwikkelingslogboek van wanneer 'n webwerf laas gewerk is.
- Verwyder gedeeltes van die kode, maar laat dit beskikbaar vir latere gebruik. Dit word dikwels gedoen tydens ter plaatse toetsing en ontfouting. As u 'n probleem op 'n webwerf het en nie seker is wat dit veroorsaak nie, kan u een afdelings een op 'n keer na kwarentyn kommentaar lewer en die probleem identifiseer en werk dan op 'n oplossing vir enige probleme wat u ondervind.
- Klets met ander ontwikkelaars wat op die kode werk. Dit sal waarskynlik tydens ontwikkeling gedoen word as 'n manier om inligting met ander wat op die kode werk, terselfdertyd te deel. As hierdie opmerkings suiwer ontwikkelingsgesprekke is, is dit 'n beste praktyk om hulle van die kode te verwyder voordat 'n webwerf bekendgestel word.
Tradisioneel word kommentaar in HTML gebruik vir bykans enige elemente, van verduidelikings van komplekse tabelstrukture tot insiggewende opmerkings van die inhoud van die bladsy self. Aangesien opmerkings nie in 'n blaaier gelewer word nie, kan jy hulle enige plek in die HTML voeg en maak nie bekommerd oor wat dit sal doen as die webwerf deur 'n kliënt beskou word nie.
Hoe om kommentaar te skryf
Om kommentaar in HTML, XHTML en XML te skryf, is baie maklik. Omring eenvoudig die teks wat jy wil kommentaar lewer met die volgende:
en ->Soos u kan sien, begin hierdie opmerkings met 'n "minder as simbool", plus 'n uitroeppunt en twee streepies. Die kommentaar eindig met nog twee stippies en 'n "groter as: simbool. Tussen daardie karakters kan jy skryf wat jy ook al wil hê.
In CSS is dit 'n bietjie anders, met behulp van C-kode kommentaar eerder as HTML. U begin met 'n voorste skuinspeling gevolg deur 'n asterisk. U eindig die kommentaar met die inverse daarvan, 'n sterretjie gevolg deur 'n voorwaartse skuinsstreep.
/ * kommentaar teks * /Kommentaar is 'n sterwende kuns
Die meeste programmeerders weet die waarde van nuttige kommentaar . Opmerklike kode maak dit makliker vir daardie kode om van een spanlid na 'n ander oorgedra te word. Opmerkings help jou QA-span om die kode te toets, want hulle kan vertel wat die ontwikkelaar beplan het - selfs al is dit nie behaal nie. Ongelukkig, met die gewildheid van webwerf-opskrifplatforms soos Wordpress, wat jou toelaat om met 'n gekose tema op te spoor wat baie, indien nie al van die HTML vir jou hanteer nie, word kommentaar nie so dikwels deur webspanne gebruik nie. Dit is omdat die kommentaar baie moeilik is om te sien in die meeste visuele outeur-instrumente as u nie direk met die kode werk nie. Byvoorbeeld, eerder as om te sien, bo-aan 'n webblad:
Die visuele instrument toon 'n klein ikoon om aan te dui dat daar 'n kommentaar is. As die ontwerper nie fisies die kommentaar oopmaak nie, kan hy dit nooit sien nie. En in die geval van die bogenoemde bladsy, kan dit probleme veroorsaak as sy die bladsy wysig en dat die redigering oorskryf word deur die skrif wat in die kommentaar genoem word.
Wat kan gedoen word?
- Skryf sinvolle en nuttige kommentaar. Moenie verwag dat ander mense jou kommentaar sal lees as hulle te lank is nie of nie nuttige inligting bevat nie.
- As ontwikkelaar moet jy altyd enige kommentaar wat jy op 'n bladsy sien, hersien.
- Gebruik gereedskap wat deur die skrywerprogramme voorsien word, wat jou toelaat om kommentaar te lewer.
- Gebruik inhoudsbestuur om te bepaal hoe die bladsye geredigeer word.
Selfs as jy die enigste persoon is wat jou webwerwe wysig, kan kommentaar nuttig wees. As jy net 'n ingewikkelde bladsy een keer per jaar wysig, is dit maklik om te vergeet hoe jy die tafel gebou het of die CSS saamstel. Met kommentaar hoef jy nie te onthou nie, soos dit nou vir jou geskryf is.
Oorspronklike artikel deur Jennifer Krynin. Geredigeer deur Jeremy Girard op 5/5/17