Įtraukite nuorodų komentarus į savo XML kodą

Jei norite įtraukti nuorodų komentarus į savo XML kodą, naudokite šį išsamią vadovėlį. Galite sužinoti, kaip šią funkciją atlikti tik per penkias minutes. Nors procesą lengva užpildyti, prieš pradėdami turėtumėte žinoti keletą pagrindinių komentarų apie XML ir jų naudingumą.

Kodėl XML komentarai yra naudingi

Komentarai XML yra beveik identiški HTML komentarams, nes jie abu turi tą patį sintaksę. Naudodamiesi komentarais galite suprasti kodą, kurį parašėte prieš daugelį metų. Tai taip pat gali padėti kitam kūrėjui, kuris peržiūrės jūsų sukurtą kodą, kad suprastumėte tai, ką parašėte. Trumpai tariant, šios pastabos pateikia kodo kontekstą.

Su komentarais galite lengvai palikti užrašą arba laikinai pašalinti dalį XML kodo. Nors XML yra sukurtas kaip "savaime apibūdinantys duomenys", kartais gali reikėti palikti XML komentarą.

Pradžia

Komentarų žymos susideda iš dviejų dalių: dalis, kurioje prasideda komentaras, ir baigiamoji dalis. Norėdami pradėti, pridėkite pirmąją komentarų žymos dalį

-->

Naudingi patarimai

Pridėdami nuorodų komentarus į savo XML kodą, nepamirškite, kad jie negali būti patys dokumento viršuje. XML dokumente gali būti tik XML deklaracija:

Kaip jau buvo minėta, komentarai gali būti nesutampa vienas su kitais. Prieš atidarius antrą, turite uždaryti savo pirmąjį komentarą. Be to, pastabos gali nebūti žymėse, pvz.,

.
Niekada nenaudokite dviejų brūkšnių (-) bet kur, bet pastabų pradžioje ir pabaigoje. Viskas, ką komentuoja, yra faktiškai nematomas XML analizatoriuje, todėl būkite labai atsargūs, kad tai, kas liko, vis dar galioja ir gerai suformuotos.

Įpakavimas

Jei vis dar kyla klausimų dėl papildomų nuorodų komentarų į XML kodą, galbūt norėsite perskaityti knygą, kad išsamiai apibūdintumėte, kaip procesas veikia. Knygos, tokios kaip Rodas Stephensas "C # 5.0 programuotojo nuoroda" gali būti naudingas.