OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.


Help: OASIS Mailing Lists Help | MarkMail Help

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index]
Re: [xml-dev] XML2.0: Comments (Was: Towards XML 2.0)

Can you give examples of this kind of structured documentation that
you mention as your second case?  I am curious... it sounds like it
might be a kind of out of band information, and not at all like
Javadoc or Java annotations.  An XML document is an instance of
something, there is presumably some definition somewhere, either
implicit or explicit, that defines it.  Annotating that instance thing
is more like attaching javadoc or an annotation to a heap object, not
to its static definition in the program source, which is analogous to
documentation in a schema.

On Sun, Dec 5, 2010 at 10:39 PM, michael odling-smee
<mike.odlingsmee@gmail.com> wrote:
> 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
> _______________________________________________________________________
> XML-DEV is a publicly archived, unmoderated list hosted by OASIS
> to support XML implementation and development. To minimize
> spam in the archives, you must subscribe before posting.
> [Un]Subscribe/change address: http://www.oasis-open.org/mlmanage/
> Or unsubscribe: xml-dev-unsubscribe@lists.xml.org
> subscribe: xml-dev-subscribe@lists.xml.org
> List archive: http://lists.xml.org/archives/xml-dev/
> List Guidelines: http://www.oasis-open.org/maillists/guidelines.php

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index]

News | XML in Industry | Calendar | XML Registry
Marketplace | Resources | MyXML.org | Sponsors | Privacy Statement

Copyright 1993-2007 XML.org. This site is hosted by OASIS