Dacă sunteți interesat să adăugați comentarii de referință la Cod XML, utilizați acest tutorial pas cu pas pentru îndrumare. Puteți afla cum să executați această funcție în doar cinci minute. Deși procesul este ușor de finalizat, trebuie să știți câteva elemente de bază despre comentariile XML și utilitatea lor înainte de a începe.
De ce sunt utile comentariile XML
Comentariile în XML sunt aproape identice cu comentariile în HTML, deoarece ambele au aceeași sintaxă. Folosind comentarii vă permite să înțelegeți codul pe care l-ați scris cu ani înainte. De asemenea, poate ajuta un alt dezvoltator care examinează codul pe care l-ați dezvoltat să înțeleagă ce ați scris. Pe scurt, aceste comentarii oferă context pentru cod.
Cu comentariile, puteți lăsa cu ușurință o notă sau puteți elimina temporar o parte a unui cod XML. Chiar dacă XML este conceput pentru a fi „date care se autodescrie”, uneori poate fi necesar să lăsați un comentariu XML.
Noțiuni de bază
Etichetele pentru comentarii sunt alcătuite din două părți: partea care începe comentariul și partea care o încheie. Pentru a începe, adăugați prima parte a etichetei de comentariu:
Apoi scrieți orice comentariu doriți. Asigurați-vă că nu includeți comentarii în alte comentarii (consultați sfaturile pentru mai multe detalii). După aceea, veți închide eticheta de comentariu:
-->
Sfaturi utile
Când adăugați comentarii de referință la codul dvs. XML, amintiți-vă că acestea nu pot apărea chiar în partea de sus a documentului. În XML, numai declarația XML poate veni pe primul loc:
După cum s-a menționat mai sus, comentariile nu pot fi cuibărite unul în altul. Trebuie să închideți primul comentariu înainte de a deschide un al doilea. De asemenea, comentariile nu pot apărea în etichete, de ex.
.
Nu folosiți niciodată cele două liniuțe (-) nicăieri, ci la începutul și la sfârșitul comentariilor dvs. Orice din comentarii este efectiv invizibil pentru Parser XML, așa că fiți foarte atenți ca ceea ce rămâne să fie încă valabil și bine format.
Încheierea
Dacă aveți încă întrebări despre 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 precum„Referința programatorului C # 5.0” de Rod Stephens se poate dovedi de ajutor.