Als u geïnteresseerd bent in het toevoegen van referentieopmerkingen aan uw XML-code, gebruik dan deze stapsgewijze zelfstudie voor begeleiding. U kunt in slechts vijf minuten leren hoe u deze functie uitvoert. Hoewel het proces eenvoudig te voltooien is, moet u nog enkele basiskennis over XML-opmerkingen en hun bruikbaarheid kennen voordat u begint.
Waarom XML-opmerkingen nuttig zijn
Opmerkingen in XML zijn bijna identiek aan opmerkingen in HTML, omdat ze beide dezelfde syntaxis hebben. Opmerkingen gebruiken stelt u in staat de code te begrijpen die u jaren eerder hebt geschreven. Het kan ook een andere ontwikkelaar helpen die de door u ontwikkelde code beoordeelt, om te begrijpen wat u hebt geschreven. Kortom, deze opmerkingen bieden context voor de code.
Met opmerkingen kunt u eenvoudig een notitie achterlaten of tijdelijk een deel van een XML-code verwijderen. Hoewel XML is ontworpen om "zelfbeschrijvende gegevens" te zijn, is het soms nodig om een XML-opmerking achter te laten.
Beginnen
Commentaartags bestaan uit twee delen: het deel waarmee de opmerking begint en het deel dat de opmerking beëindigt. Voeg om te beginnen het eerste deel van de commentaartag toe:
Schrijf dan welke opmerking je maar wilt. Zorg er wel voor dat u geen opmerkingen in andere opmerkingen nest (zie tips voor meer details). Daarna sluit je de commentaartag:
-->
Bruikbare tips
Houd er bij het toevoegen van referentieopmerkingen aan uw XML-code rekening mee dat deze niet helemaal bovenaan uw document mogen komen. In XML kan alleen de XML-declaratie eerst komen:
Zoals hierboven vermeld, mogen opmerkingen niet in elkaar worden genest. Je moet je eerste reactie sluiten voordat je een tweede opent. Ook kunnen opmerkingen niet voorkomen binnen tags, b.v.
.
Gebruik de twee streepjes (--) nooit ergens anders dan aan het begin en einde van uw opmerkingen. Alles in opmerkingen is effectief onzichtbaar voor de XML-parser, dus wees heel voorzichtig dat wat overblijft nog steeds geldig en goed gevormd is.
Afsluiten
Als je nog vragen hebt over het toevoegen van referentie-opmerkingen aan XML-code, wil je misschien een boek lezen om je een gedetailleerd beeld te geven van hoe het proces werkt. Boeken zoals"C# 5.0 Programmer's Reference" door Rod Stephens kan helpen.