Kako dodati referenčne pripombe k vaši kodi XML

Pridobite dejstva s tem vodnikom po korakih

Če želite dodati referenčne pripombe k vaši kodi XML, uporabite to navodilo po korakih za navodila. Naučite se, kako izvedete to funkcijo v samo petih minutah. Medtem ko je postopek enostaven za dokončanje, morate še vedno poznati nekaj osnov o komentarjih XML in njihovo uporabnost, preden začnete.

Zakaj so komentarji XML koristni

Komentarji v XML so skoraj enaki kot komentarji v HTML-ju, saj imata oba isto sintakso. Uporaba komentarjev vam omogoča razumevanje kode, ki ste jo napisali že prej. Prav tako lahko pomaga drugemu razvijalcu, ki pregleda kodo, ki ste jo razvili, razumeti, kaj ste napisali. Skratka, ti komentarji zagotavljajo kontekst kode.

S komentarji lahko enostavno zapustite opombo ali začasno odstranite del kode XML. Čeprav je XML namenjen za "samo-opisovanje podatkov", boste morda morali zapustiti komentar na XML.

Začetek

Oznake za komentiranje so sestavljene iz dveh delov: dela, ki začne komentar in dela, ki ga je končal. Če želite začeti, dodajte prvi del oznake za komentar kateri koli komentar, ki ga želite. Prepričajte se, da v drugih komentarjih ne komentirate komentarjev (glejte nasvete za več podrobnosti).

Po tem boste zaprli oznako komentarja ->

Koristni nasveti

Ko dodate referenčne pripombe k vaši XML kodi, ne pozabite, da ne morejo priti na sam vrh dokumenta. V XML lahko pride samo deklaracija XML:

Kot je bilo že omenjeno, komentarjev morda ni vgrajen znotraj enega. Najprej morate zapreti svoj prvi komentar, preden odprete sekundo. Tudi v oznakah ni mogoče komentirati, npr. .

Nikoli ne uporabljajte pomišljajev (-) kjerkoli, ampak na začetku in koncu vaših komentarjev. Karkoli v komentarjih je za razčlenjevalnika XML dejansko nevidno, zato bodite previdni, da je ostalo še vedno veljavno in dobro oblikovano.

Zavijanje

Če imate še vedno vprašanja o dodajanju referenčnih komentarjev k kodi XML, boste morda želeli prebrati knjigo, da boste dobili podrobno sliko o tem, kako deluje proces. Knjige, kot so C # 5.0 Programmer's Reference by Rod Stephens, se lahko izkažejo za koristne. Preverite spletne trgovce na drobno ali lokalno knjižnico za podobne knjige.