Obțineți faptele cu acest ghid pas cu pas
Dacă sunteți interesat să adăugați comentarii de referință la codul dvs. XML, utilizați acest tutorial pas cu pas pentru îndrumare. Puteți afla cum să executați această funcție în doar cinci minute. În timp ce procesul este ușor de completat, trebuie să știți încă câteva informații despre comentariile XML și utilitatea acestora înainte de a începe.
De ce comentariile XML sunt utile
Comentariile în XML sunt aproape identice cu comentariile din HTML, ambele având aceeași sintaxă. Utilizarea comentariilor vă permite să înțelegeți codul pe care l-ați scris cu ani în urmă. De asemenea, poate ajuta un alt dezvoltator care revizuiește codul pe care l-ați dezvoltat să înțeleagă ceea ce ați scris. Pe scurt, aceste comentarii oferă context pentru cod.
Cu comentarii, puteți lăsa ușor o notă sau puteți elimina temporar o parte din codul XML. Chiar dacă XML este conceput să fie "auto-descrierea datelor", ocazional poate fi necesar să lăsați un comentariu XML.
Noțiuni de bază
Etichetele pentru comentarii sunt compuse din două părți: partea care începe comentariul și partea care îl termină. Pentru a începe, adăugați prima parte a etichetei de comentariu orice comentariu doriți. Asigurați-vă că nu introduceți comentarii în alte comentarii (consultați sfaturile pentru mai multe detalii).
După aceasta, veți închide eticheta de comentariu ->
Sfaturi utile
Când adăugați comentarii la codul dvs. XML, amintiți-vă că acestea nu pot veni chiar în partea de sus a documentului. În XML, numai declarația XML poate fi prima:
După cum sa menționat mai sus, comentariile nu pot fi imbricate unul în altul. Trebuie să închideți primul comentariu înainte de a deschide o secundă. De asemenea, comentariile nu pot apărea în etichete, de exemplu
Nu utilizați niciodată cele două liniuțe (-) oriunde, dar la începutul și la sfârșitul comentariilor dvs. Orice comentariu este efectiv invizibil pentru parserul XML, așa că fiți foarte atent că ceea ce rămâne rămâne valabil și bine format.
Înfășurarea în sus
Dacă aveți în continuare întrebări legate de adăugarea comentariilor de referință la codul XML, vă recomandăm să citiți o carte pentru a vă oferi o imagine detaliată a modului în care funcționează procesul. Cărți cum ar fi C # 5.0 Programmer's Reference de Rod Stephens s-ar putea dovedi de ajutor. Verificați comercianții cu amănuntul online sau biblioteca locală pentru cărți similare.