Če vas zanima dodajanje referenčnih komentarjev na vaš Koda XML, uporabite ta navodila po korakih za navodila. Naučite se izvajati to funkcijo v samo petih minutah. Čeprav je postopek enostavno zaključiti, morate vseeno poznati nekaj osnov o komentarjih XML in njihovi uporabnosti, preden začnete.
Zakaj so komentarji XML koristni
Komentarji v XML so skoraj enaki komentarjem v HTML-ju, saj imajo oba enako sintakso. Uporaba komentarjev omogoča razumevanje kode, ki ste jo pisali pred leti. Drugemu razvijalcu, ki pregleduje kodo, ki ste jo razvili, lahko pomaga razumeti, kaj ste napisali. Skratka, ti komentarji predstavljajo kontekst kode.
S komentarji lahko preprosto pustite opombo ali začasno odstranite del kode XML. Čeprav je XML zasnovan tako, da je "samoopisni podatki", boste občasno morda morali pustiti komentar XML.
Kako začeti
Oznake komentarjev so sestavljene iz dveh delov: dela, ki začne komentar in dela, ki ga konča. Za začetek dodajte prvi del oznake komentarja:
Nato napišite komentar, ki ga želite. Prepričajte se, da komentarjev ne gnetete v drugih komentarjih (za več podrobnosti glejte nasvete). Po tem boste zaprli oznako komentarja:
-->
Koristni nasveti
Ko v kodo XML dodajate referenčne komentarje, ne pozabite, da ne morejo biti na samem vrhu dokumenta. V XML je lahko na prvem mestu le izjava XML:
Kot smo že omenili, komentarji ne smejo biti vgnezdeni drug v drugega. Prvi komentar morate zapreti, preden odprete drugega. Tudi komentarji ne morejo biti znotraj oznak, npr.
.
Nikoli ne uporabljajte obeh pomišljajev (-), razen na začetku in koncu komentarjev. Vse, kar je v komentarjih, je dejansko nevidno Razčlenjevalnik XML, zato bodite zelo previdni, da bo tisto, kar ostane, še vedno veljavno in dobro oblikovano.
Zavijanje
Če imate še vedno vprašanja o dodajanju referenčnih komentarjev v kodo XML, boste morda želeli prebrati knjigo, da boste dobili podrobno sliko o tem, kako postopek deluje. Knjige, kot so"Priročnik programerja C # 5.0", avtor Rod Stephens se lahko izkaže za koristno.