Kuinka kommentoida riviä XML-muodossa

Ohjelmoija, joka työskentelee ohjelmakoodin kanssa

Toisin kuin HTML, XML-tunnisteet tarjoavat kuvaavia yksityiskohtia sisällöstä visuaalisten ohjeiden sijaan sen näyttämiseen.

Kuvan luotto: RossHelen/iStock/GettyImages

XML tarjoaa merkintäkielen tietojen tallentamiseen ja siirtämiseen paikasta toiseen. Kuten HTML, se käyttää pelkkää tekstiä, jota voit muokata missä tahansa TXT-tiedostoja kirjoittavassa sovelluksessa. Toisin kuin HTML, XML-tunnisteet tarjoavat kuvaavia yksityiskohtia sisällöstä visuaalisten ohjeiden sijaan sen näyttämiseen. Kun määrität XML-tunnisteita luonnehtimaan tietojoukkoa, voit käyttää kommentteja palvelemaan kahta työsi tarkoituksiin: selittää sitä ja jättää koodista pois sen osia, joita muut sovellukset käyttävät käsitellä asiaa. Jos tiedät jo HTML-kommenttien syntaksin, tiedät myös XML-vastineen.

Jos haluat kommentoida yhden rivin XML-koodissa, aseta kohdistin sen rivin alkuun, jota haluat kommentoida. A tyypin pienempi kuin -symboli, jota seuraa huutomerkki ja kaksi viivaa. Siirrä kohdistin rivin loppuun ja kirjoita sitten kaksi viivaa, jota seuraa suurempi kuin -symboli.

Päivän video

Jos rivisi koostuu lauseesta "Käytä tätä osiota adoptoitavien kissojen kuvauksen luomiseen", se näyttää tältä molempien kommenttitunnisteiden ollessa paikoillaan:

Sinun kannattaa lukea kommenttisi varmistaaksesi, ettei se sisällä kahta peräkkäistä viivaa muita kuin sen avaavassa ja sulkevassa kommenttitunnisteessa. Peräkkäiset viivat laukaisevat väärän kommentin loppusignaalin, joka häiritsee syntaksiasi.

Sen sijaan, että kommentoit vain yhtä riviä, saatat joutua kommentoimaan koko osan XML-koodistasi. Voit tehdä tämän asettamalla kohdistimen tyhjälle riville sen XML-koodin osan yläpuolelle, jota haluat kommentoida, ja kirjoittamalla sitten pienempi kuin -symboli, jota seuraa huutomerkki ja kaksi viivaa.

Lopeta kommentti siirtämällä kohdistin tyhjälle riville sen XML-koodin osan jälkeen, jota kommentoit. Tyyppi kaksi viivaa, jota seuraa suurempi kuin -symboli. Kun kommentit ovat paikallaan, osa XML-koodista näyttää tältä:

Haluat jälleen lukea kommentoimasi osion varmistaaksesi, että se ei sisällä kommenttia kommentoimillasi riveillä. Sisäkkäiset kommentit muodostavat virheen XML: ssä.

Kun kirjoitat kommentteja, muista muutama XML-syntaksisääntö. XML ei salli alle-merkin käyttöä koodissaan, paitsi osana avauskommenttitunnistetta. Jos haluat sisällyttää merkin mihin tahansa muuhun kuin kommenttitunnisteeseen, kirjoita se muodossa entiteetin viite, koodattu sekvenssi, joka muuttuu tietyksi merkiksi, kun sovellus jäsentää XML: si.

Jokainen entiteettiviittaus alkaa et-merkillä ja päättyy puolipisteeseen. Näiden kahden merkin välissä pienempi kuin -symbolin entiteettiviite sisältää pienet kirjaimet "lt" ilman lainausmerkkejä ja välimerkkejä. Suurempi kuin -symboli ei ole laiton merkki XML: ssä, mutta on hyvä käytäntö käyttää myös sen entiteettiviittausta, joka sisältää kirjaimet "gt".

Muista myös, että jos et avaa ja sulje kommenttejasi oikein tai sijoita ne tunnuksen sisältävän koodiosan ympärille, XML-tiedostosi ei jäsenny kunnolla.