Re: [xml-dev] XML2.0: Comments (Was: Towards XML 2.0)

[michael odling-smee <mike.odlingsmee@gmail.com>]

On Sun, Dec 5, 2010 at 11:01 AM, Pete Cordell <petexmldev@codalogic.com> wrote:
> Initially I liked the <xml:comment>....</xml:comment> idea, but I now agree
> with Greg that comments should allow non well-formed data.  Since a comment
> looking like an element would suggest it was well-formed, I think a
> non-element style format should be used.  Tweaking XML 1.0 comments seems
> sufficient rather than a wholesale replacement.

There seems to be two main uses of comments in XML today which is
aligned with the two schools of thought in this thread:

1.] Simply commenting out code or adding TODOs etc. - similar use to
standard code comments.
2.] Adding structured documentation - similar to JavaDoc/annotations.

As these have different uses perhaps we need two different constructs.
For the simple code comment perhaps we just need a refined version of
the current XML 1.0 comment, for the structured documentation perhaps
we need something along the lines of
<xml:documentation></xml:documentation> with the potential for nested
structures.

Michael
www.xml-solutions.com