Kui soovite lisada oma kommentaaridele kommentaare XML-kood, kasutage juhendamiseks seda samm-sammult õpetust. Selle funktsiooni täitmise saate teada vaid viie minutiga. Kuigi protsessi on lihtne lõpule viia, peaksite enne alustamist siiski teadma XML-i kommentaaride ja nende kasulikkuse põhitõdesid.
Miks XML-i kommentaarid on kasulikud?
XML-i kommentaarid on peaaegu identsed HTML-i kommentaaridega, kuna neil mõlemal on sama süntaks. Kommentaaride kasutamine võimaldab teil mõista aastaid varem kirjutatud koodi. See võib aidata ka teisel arendajal, kes teie välja töötatud koodi üle vaatab, aru saada, mida kirjutasite. Lühidalt, need kommentaarid pakuvad koodeksile konteksti.
Kommentaaride abil saate hõlpsalt märkuse jätta või osa XML-koodist ajutiselt eemaldada. Isegi kui XML on loodud "ennast kirjeldavateks andmeteks", peate mõnikord jätma XML-i kommentaari.
Alustamine
Kommentaarimärgendid koosnevad kahest osast: kommentaari alustavast ja selle lõpetavast osast. Alustamiseks lisage kommentaarimärgendi esimene osa:
Seejärel kirjutage mis tahes kommentaar, mida soovite. Lihtsalt veenduge, et te ei pesaks kommentaare teiste kommentaaride sisse (lisateavet leiate nõuannetest). Pärast seda sulgete kommentaarimärgendi:
-->
Kasulikud näpunäited
XML-koodile viitekommentaaride lisamisel pidage meeles, et need ei saa olla teie dokumendi ülaosas. XML-is saab esikohale tulla ainult XML-deklaratsioon:
Nagu eespool mainitud, ei pruugi kommentaarid üksteise sisse pesitseda. Enne teise avamist peate oma esimese kommentaari sulgema. Samuti ei saa märgendeid sees kommentaare esineda, nt.
.
Ärge kunagi kasutage kaht kriipsu (-) kusagil mujal kui kommentaaride alguses ja lõpus. Kõik kommentaarides märkatu on kasutajale nähtamatu XML-i parser, nii et olge väga ettevaatlik, et see, mis jääb, oleks endiselt kehtiv ja hästi vormistatud.
Pakkimine
Kui teil on endiselt küsimusi XML-koodile viitekommentaaride lisamise kohta, võiksite lugeda raamatut, et anda teile üksikasjalik ülevaade protsessi toimimisest. Raamatud nagu"Steppersi C # 5.0 programmeerija viide" võib osutuda kasulikuks.