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:
- Add the first part of the comment tag <!--
- Write whatever comment you would like - just make sure you don't nest comments within other comments (see tips for more details).
- Close the comment tag -->
Tips:
- Comments cannot come at the very top of your document. In XML, only the XML declaration can come first:
<?xml version="1.0"?> - Comments may not be nested one inside another. You must close your first comment before you open a second.
- Comments cannot occur within tags, e.g. <tag ></tag>.
- Never use the two dashes (--) anywhere but at the beginning and end of your comments.
- Anything in comments is effectively invisible to the XML parser, so be very careful that what remains is still valid and well-formed.
