Hvis du er interessert i å legge til referansekommentarer til din XML-kode, bruk denne trinnvise veiledningen for veiledning. Du kan lære hvordan du utfører denne funksjonen på bare fem minutter. Selv om prosessen er enkel å fullføre, bør du likevel vite noen grunnleggende om XML-kommentarer og deres nytte før du begynner.
Hvorfor XML-kommentarer er nyttige
Kommentarer i XML er nesten identiske med kommentarer i HTML, da de begge har samme syntaks. Bruke kommentarer lar deg forstå koden du skrev år før. Det kan også hjelpe en annen utvikler som vurderer koden du utviklet, for å forstå hva du skrev. Kort sagt gir disse kommentarene kontekst for koden.
Med kommentarer kan du enkelt legge igjen et notat eller midlertidig fjerne en del av en XML-kode. Selv om XML er designet for å være "selvbeskrivende data", kan det hende at du må legge igjen en XML-kommentar.
Starter
Kommentarmerker består av to deler: delen som starter kommentaren og delen som avslutter den. For å starte, legg til den første delen av merkelappen:
Skriv deretter hvilken kommentar du ønsker. Bare vær sikker på at du ikke hekker kommentarer i andre kommentarer (se tips for mer informasjon). Etter det lukker du merkelappen:
-->
Nyttige tips
Når du legger til referansekommentarer til XML-koden din, må du huske at de ikke kan komme helt øverst i dokumentet. I XML kan bare XML-erklæringen komme først:
Som nevnt ovenfor, kan det hende at kommentarer ikke er nestet hverandre. Du må lukke den første kommentaren din før du åpner et sekund. Kommentarer kan heller ikke forekomme i tagger, f.eks.
.
Bruk aldri de to bindestrekene (-) hvor som helst, men i begynnelsen og slutten av kommentarene. Alt i kommentarer er effektivt usynlig for XML-parser, så vær veldig forsiktig med at det som gjenstår fortsatt er gyldig og velformet.
Innpakning
Hvis du fortsatt har spørsmål om å legge til referansekommentarer til XML-kode, kan det være lurt å lese en bok for å gi deg et detaljert bilde av hvordan prosessen fungerer. Bøker som f.eks"C # 5.0 Programmer's Reference" av Rod Stephens kan være nyttig.