Hoe een regel in XML te becommentariëren

Programmeur die met programmacode werkt

In tegenstelling tot HTML bieden XML-tags beschrijvende details over inhoud in plaats van visuele instructies om deze weer te geven.

Afbeelding tegoed: RossHelen/iStock/GettyImages

XML biedt een opmaaktaal voor het opslaan van gegevens en het overbrengen van de ene naar de andere locatie. Net als HTML gebruikt het platte tekst die u kunt bewerken in elke toepassing die TXT-bestanden schrijft. In tegenstelling tot HTML bieden XML-tags beschrijvende details over inhoud in plaats van visuele instructies om deze weer te geven. Terwijl u XML-tags definieert om een ​​set informatie te karakteriseren, kunt u opmerkingen gebruiken om twee te dienen: doeleinden binnen je werk: om het uit te leggen, en om delen ervan weg te laten uit de code die andere toepassingen Verwerken. Als u de syntaxis van HTML-commentaar al kent, kent u ook het XML-equivalent.

Als u commentaar wilt geven op een enkele regel in de XML-code, plaatst u uw cursor aan het begin van een regel waarvan u commentaar wilt geven. Type A

kleiner-dan-symbool gevolgd door een uitroepteken en twee streepjes. Verplaats uw cursor naar het einde van de regel en typ vervolgens twee streepjes gevolgd door een groter-dan-symbool.

Video van de dag

Als je regel bestaat uit de verklaring "Gebruik deze sectie om een ​​beschrijving van adopteerbare katten te maken", ziet het er als volgt uit met beide commentaartags op hun plaats:

U wilt uw opmerking lezen om te controleren of deze geen enkele instantie van twee opeenvolgende streepjes bevat, behalve in de openings- en sluitingstags voor opmerkingen. Opeenvolgende streepjes veroorzaken een vals einde-van-commentaar-signaal dat uw syntaxis verstoort.

In plaats van slechts een enkele regel te becommentariëren, moet u mogelijk een hele sectie van uw XML-code van commentaar voorzien. Om dit te doen, plaatst u uw cursor op een lege regel boven het gedeelte van de XML-code waar u commentaar op wilt geven en typt u vervolgens a kleiner-dan-symbool gevolgd door een uitroepteken en twee streepjes.

Om de opmerking te beëindigen, verplaatst u uw cursor naar een lege regel na het gedeelte van de XML-code waarin u een opmerking plaatst. Type twee streepjes gevolgd door een groter-dan-symbool. Als er opmerkingen zijn, ziet een gedeelte van de XML-code er als volgt uit:

Nogmaals, je zult je commentaargedeelte willen lezen om te controleren of het geen commentaar bevat binnen de regels die je hebt geplaatst. Geneste opmerkingen vormen een fout in XML.

Houd bij het maken van opmerkingen rekening met enkele basisregels voor XML-syntaxis. XML staat het gebruik van het minder-dan-teken in de code niet toe, behalve als onderdeel van een openingscommentaar-tag. Om het teken in iets anders op te nemen, behalve een commentaartag, voert u het in als een entiteit referentie, een gecodeerde reeks die verandert in een specifiek teken wanneer een toepassing uw XML ontleedt.

Elke entiteitsreferentie begint met een ampersand en eindigt met een puntkomma. Tussen deze twee tekens bevat de entiteitsverwijzing voor het kleiner-dan-symbool de kleine letters "lt", zonder de aanhalingstekens en interpunctie. Het groter-dan-symbool vormt geen illegaal teken in XML, maar het is een goede gewoonte om ook de entiteitsverwijzing te gebruiken, die de letters 'gt' bevat.

Houd er ook rekening mee dat als u uw opmerkingen niet correct opent en sluit, of ze rond een codegedeelte plaatst dat een ID bevat, uw XML niet correct wordt geparseerd.