1. Technology

How To Comment Your XML

By

Woman's hand working with laptop in office
Guido Mieth/Moment/Getty Images
Top Related Searches
  • lt xml
  • xml declaration
  • dashes
  • Comments in XML are nearly identical to comments in HTML. Using comments allows you to understand code you wrote years before, or another developer to review.
    Difficulty: Easy
    Time Required: 5 minutes

    Here's How:

    1. Comment tags are two parts, the part starting the comment and the part ending it. First, add the first part of the comment tag <!--
    2. Write whatever comment you would like - just make sure you don't nest comments within other comments (see tips for more details).
    3. Close the comment tag -->

    Tips:

    1. Comments cannot come at the very top of your document. In XML, only the XML declaration can come first:
      <?xml version="1.0"?>
    2. Comments may not be nested one inside another. You must close your first comment before you open a second.
    3. Comments cannot occur within tags, e.g. <tag ></tag>.
    4. Never use the two dashes (--) anywhere but at the beginning and end of your comments.
    5. Anything in comments is effectively invisible to the XML parser, so be very careful that what remains is still valid and well-formed.

    ©2014 About.com. All rights reserved.