Kio estas HTML-Komentoj kaj Kiel ili estas Uzitaj
Kiam vi rigardas retpaĝon en retumilo, vi vidas vidan reprezenton de tiu ĉi programaro (la retumilo) montras laŭ la kodo de aparta retpaĝo. Se vi vidos tiun fontkodon de la retpaĝo, vi vidos dokumenton formitan de diversaj HTML-elementoj, inkluzive de alineoj, rubrikoj, listoj, ligiloj, bildoj kaj pli. Ĉiuj ĉi tiuj elementoj estas senditaj de la retumilo sur la ekrano de vizitanto kiel parto de la ekrano de la retejo. Unu afero, kiun vi povas trovi en HTML-kodo, kiu ne estas prezentita sur la ekrano de persono, estas kio estas nomata "HTML-komentoj".
Kio Estas Komento?
Komento estas kordo de kodo ene de HTML, XML, aŭ CSS, kiu ne estas rigardata aŭ agita per la retumilo aŭ analizilo. Ĝi estas simple skribita en la kodon por provizi informojn pri tiu kodo aŭ aliajn retpoŝtojn de la kodaj programistoj.
Plej multaj lingvoj de programado havas komentojn, ili kutime uzas la programiston de la kodo por unu aŭ eĉ pli ol unu el la jenaj kialoj:
- Priskribu kaj klarigu komplikan kodon al iu, kiu eble devas labori en ĝi en la estonteco - inkluzive al si mem! Ili povas reveni al kodo 3 aŭ 6 el 12 monatoj aŭ pli poste kaj ne memoras kial ili faris ion certan. Komentoj povas helpi respondi iliajn demandojn kaj rememori ilin pri kie ilia menso estis kiam ili unue evoluigis tiun paĝon.
- Provizu detalojn pri kiam la kodo estis redaktata aŭ reviziita. Ĉi tio povas esti helpema informo kaj agas iomete kiel evoluiga protokolo de kiam retejo lastatempe funkciis.
- Forigi sekciojn de la kodo, sed lasu ilin disponeblaj por posta uzo. Ĉi tio ofte fariĝas dum la elprovado kaj elpurigado de la retejo. Se vi havas problemon sur retejo kaj ne certas, kio kaŭzas ĝin, vi povas komentigi sekciojn unufoje al quarentino kaj identigi la aferon kaj poste funkcii ripari por kiom ajn problemoj vi havas.
- Konversacii kun aliaj programistoj laborante sur la kodo. Ĉi tio verŝajne fariĝos dum la disvolviĝo kiel maniero dividi detalojn kun aliaj laborantaj en la kodo samtempe. Se ĉi tiuj komentoj estas simple disvolviĝaj konversacioj, ĝi estas plej bona praktiko forigi ilin el la kodo antaŭ ol lanĉu retejo.
Tradicie, komentoj en HTML estas uzataj por preskaŭ ajnaj elementoj, el eksplikoj de kompleksaj tabloj-strukturoj al informaj rimarkoj pri la enhavo de la paĝo mem. Ĉar komentoj ne estas prezentitaj en retumilo, vi povas aldoni ilin ie ajn en la HTML kaj ne zorgas pri tio, kion ĝi faros kiam la retejo estas vidita de kliento.
Kiel Skribi Komentojn
Skribi komentojn en HTML, XHTML kaj XML estas tre facila. Simple ĉirkaŭu la tekston, kiun vi volas diri kun la sekvaj:
kaj ->Kiel vi povas vidi, ĉi tiuj komentoj komenciĝas per "malpli ol simbolo", krom eksklamado kaj du paŝoj. La komento finiĝas per du pli da dashes kaj "pli granda ol: simbolo. Inter tiuj signoj vi povas skribi, kion ajn vi volas fari la korpon de la komento.
En CSS, ĝi estas iom malsama, uzante C-komentojn kompare ol HTML Vi komencas kun antaŭa ŝelo sekvata de asterisko. Vi finas la komenton kun la inversaĵo de tio, asterisko sekvita de antaŭa slash.
/ * komentis tekston * /Komentoj estas Malsa Arto
Plej programistoj scias la valoron de utilaj komentoj . Komentita kodo faras pli facile por tiu kodo esti translokigita de unu membro-membro al alia. Komentoj helpas vin QA-teamon por provi la kodon, ĉar ili povas diri kion la programisto intencis - eĉ se ĝi ne sukcesis. Bedaŭrinde, kun la populareco de retpaĝaj aŭtomataj platformoj kiel Wordpress, kiu ebligas vin leviĝi kaj kurante per elektita temo, kiu manipulas multon, se ne ĉiuj, de la HTML por vi, komentoj ne estas uzataj kiel ofte de retaj teamoj. Ĉi tio estas, ĉar la komentoj estas tre malfacile vidi en plej multaj vidaj aŭtoraj iloj, se vi ne funkcias rekte kun la kodo. Ekzemple, prefere ol vidi, ĉe la supro de retpaĝo:
La vida ilo montras malgrandan ikonon por indiki ke komento estas tie. Se la desegnisto ne fizike malfermas la komenton, li neniam povas vidi ĝin. Kaj en la kazo de la supra paĝo, ĝi povus kaŭzi problemojn, se ŝi redaktas la paĝon kaj tiu redaktado estas subskribita per la skripto menciita en la komento.
Kion Povas Fariĝi?
- Skribu signifajn kaj utilajn komentojn. Ne atendu aliajn homojn legi viajn komentojn, se ili estas tro longaj aŭ ne inkluzivas helpemajn informojn.
- Kiel programisto, vi ĉiam devus revizii iujn komentojn, kiujn vi vidas en paĝo.
- Uzu ilojn provizitajn de la aŭtomataj programoj, kiuj permesas aldoni komentojn.
- Uzu enhavadministradon por kontroli kiel la paĝoj estas redaktataj.
Eĉ se vi estas la sola persono, kiu redaktas viajn retpaĝojn, komentoj povas esti utilaj. Se vi nur redaktas komplikan paĝon unufoje jare, estas facile forgesi, kiel vi konstruis la tablon aŭ kunmetis la CSS. Kun komentoj, vi ne devas memori, ĉar ĝi estas skribita ĝuste por vi.
Originala artikolo de Jennifer Krynin. Redaktita de Jeremy Girard la 5/5/17