Ako ste zainteresirani za dodavanje referentnih komentara na svoj XML kod, upotrijebite ovaj detaljni vodič za smjernice. Možete naučiti kako izvršiti ovu funkciju u samo pet minuta. Iako je postupak lako dovršiti, ipak biste trebali znati neke osnove o XML komentarima i njihovoj korisnosti prije nego što započnete.
Zašto su XML komentari korisni
Komentari u XML-u gotovo su identični komentarima u HTML-u, jer oba imaju istu sintaksu. Koristeći komentare omogućuje vam razumijevanje koda koji ste napisali godinama prije. Također može pomoći drugom programeru koji pregledava kod koji ste razvili da shvati što ste napisali. Ukratko, ovi komentari pružaju kontekst koda.
Uz komentare možete jednostavno ostaviti bilješku ili privremeno ukloniti dio XML koda. Iako je XML dizajniran da bude "samoopisivi podaci", ponekad ćete možda trebati ostaviti XML komentar.
Početak rada
Oznake komentara sastoje se od dva dijela: dijela koji započinje komentar i dijela koji ga završava. Za početak dodajte prvi dio oznake komentara:
Zatim napišite bilo koji komentar koji želite. Samo pazite da komentare ne ugnijezdite u druge komentare (pogledajte savjete za više detalja). Nakon toga zatvorit ćete oznaku komentara:
-->
Korisni savjeti
Kada dodajete referentne komentare u svoj XML kôd, imajte na umu da oni ne mogu biti na samom vrhu vašeg dokumenta. U XML-u samo XML deklaracija može biti na prvom mjestu:
Kao što je gore spomenuto, komentari se ne smiju ugnijezditi jedan u drugi. Morate zatvoriti svoj prvi komentar prije nego što otvorite drugi. Također, komentari se ne mogu pojaviti unutar oznaka, npr.
.
Dvije crtice (-) nikada nemojte koristiti bilo gdje, osim na početku i na kraju komentara. Sve u komentarima učinkovito je nevidljivo za XML parser, zato budite vrlo oprezni da ono što ostane i dalje bude valjano i dobro oblikovano.
Završavati
Ako i dalje imate pitanja o dodavanju referentnih komentara u XML kôd, možda ćete htjeti pročitati knjigu kako biste dobili detaljnu sliku o tome kako postupak radi. Knjige poput"Reference programera C # 5.0", Rod Stephens može se pokazati korisnim.