Hvis du er interesseret i at tilføje referencekommentarer til din XML-kode, brug denne trinvise tutorial til vejledning. Du kan lære at udføre denne funktion på bare fem minutter. Mens processen er let at gennemføre, skal du stadig kende nogle grundlæggende om XML-kommentarer og deres anvendelighed, før du begynder.
Hvorfor XML-kommentarer er nyttige
Kommentarer i XML er næsten identiske med kommentarer i HTML, da de begge har samme syntaks. Brug af kommentarer giver dig mulighed for at forstå den kode, du skrev år før. Det kan også hjælpe en anden udvikler, der gennemgår den kode, du har udviklet, til at forstå, hvad du skrev. Kort sagt, disse kommentarer giver sammenhæng for koden.
Med kommentarer kan du nemt efterlade en note eller midlertidigt fjerne en del af en XML-kode. Selvom XML er designet til at være "selvbeskrivende data", skal du til tider muligvis efterlade en XML-kommentar.
Kom godt i gang
Kommentar-tags består af to dele: den del, der starter kommentaren, og den del, der slutter den. For at starte skal du tilføje den første del af kommentar-tagget:
Skriv derefter den kommentar, du gerne vil have. Bare sørg for at du ikke reden kommentarer i andre kommentarer (se tip for flere detaljer). Derefter lukker du kommentar-tagget:
-->
Nyttige tip
Når du tilføjer referencekommentarer til din XML-kode, skal du huske, at de ikke kan komme øverst i dit dokument. I XML kan kun XML-erklæringen komme først:
Som nævnt ovenfor er kommentarer muligvis ikke indlejret i hinanden. Du skal lukke din første kommentar, før du åbner et sekund. Kommentarer kan heller ikke forekomme inden for tags, f.eks.
.
Brug aldrig de to bindestreger (-) andre steder end i begyndelsen og slutningen af dine kommentarer. Alt i kommentarer er effektivt usynligt for XML-parser, så vær meget forsigtig med, at det, der er tilbage, stadig er gyldigt og velformet.
Afslutter
Hvis du stadig har spørgsmål om tilføjelse af referencekommentarer til XML-kode, kan du måske læse en bog for at give dig et detaljeret billede af, hvordan processen fungerer. Bøger som f.eks"C # 5.0 Programmer's Reference" af Rod Stephens kan være nyttigt.