Upoznajte činjenice sa ovim vodičem korak po korak
Ako ste zainteresovani da dodate referentne komentare na svoj XML kôd, koristite ovaj korak-po-korak vodič za uputstva. Možete naučiti kako izvršiti ovu funkciju za samo pet minuta. Iako je proces lako završiti, i dalje morate znati neke osnove o XML komentarima i njihovu korisnost pre nego što počnete.
Zašto su XML komentari korisni
Komentari u XML-u su skoro identični sa komentarima u HTML-u, oboje imaju istu sintaksu. Korištenje komentara omogućava vam da razumete kôd koje ste napisali nekoliko godina ranije. Takođe može pomoći drugom programeru koji pregledava kod koji ste razvili shvatite šta ste napisali. Ukratko, ovi komentari daju kontekst kodu.
Sa komentarima možete jednostavno ostaviti napomenu ili privremeno ukloniti dio XML koda. Iako je XML dizajniran da bude "samo-opisujući podatke", u nekim slučajevima možda ćete morati ostaviti XML komentar.
Počinjemo
Oznake komentara sastoje se od dva dela: dijela koji započinje komentar i deo koji ga završava. Da biste započeli, dodajte prvi deo oznake za komentare šta god želite. Samo se uverite da ne komentarišete komentare u okviru drugih komentara (pogledajte savete za više detalja).
Nakon toga zatvorite oznaku za komentare ->
Korisni saveti
Kada dodate referentne komentare na svoj XML kôd, zapamtite da oni ne mogu doći na sam vrh dokumenta. U XML-u, samo XML deklaracija može biti prva:
Kao što je gore rečeno, komentari možda ne budu ugnježeni jedan u drugi. Morate zatvoriti svoj prvi komentar pre nego što otvorite sekundu. Takođe, komentari se ne mogu pojaviti unutar oznaka, npr.
Nikada ne koristite ova dva dirka (-) bilo gde, ali na početku i kraju vaših komentara. Sve u komentarima je efikasno nevidljivo za XML parser, pa budite veoma oprezni da ono što ostaje je i dalje validno i dobro formirano.
Zavijanje
Ako i dalje imate pitanja o dodavanju referentnih komentara na XML kod, možda biste želeli da pročitate knjigu kako biste dobili detaljnu sliku o tome kako taj proces funkcioniše. Knjige kao što je C # 5.0 referent programa Rod Stephens mogu biti korisne. Proverite online prodavce ili lokalnu biblioteku za slične knjige.