[XML-DEV Mailing List Archive Home] [By Thread] [By Date] [Recent Entries] [Reply To This Message]

Re: Documenting XSLT (Was: Note from the Troll)


documenting xslt
In a message dated 28/10/2002 20:22:23 GMT Standard Time, dareo@m... writes:


What does a documentation element add to XSLT that XML comments cannot provide?


A documentation element, if properly used, would assist automatically generating documentation using XSLT as can now be done for large SVG or XSD Schema files.

For example, the documentation produced as the result of a transformation could be structured by selecting the <desc> which is a child of the document <svg> element in a particular way, using <desc> elements nested within the <defs> section in another and processing the remainder of the <desc> elements in a separate section. I don't think can be (so conveniently?) done with comments.

Additionally, having a documentation element would assist debugging of XSLT stylesheets. If you use comments heavily for documentation it is more awkward to comment out sections of code since comments don't nest. If a documentation element existed I would expect that the debugging process would be easier.

Andrew Watt

PURCHASE STYLUS STUDIO ONLINE TODAY!

Purchasing Stylus Studio from our online shop is Easy, Secure and Value Priced!

Buy Stylus Studio Now

Download The World's Best XML IDE!

Accelerate XML development with our award-winning XML IDE - Download a free trial today!

Don't miss another message! Subscribe to this list today.
Email
First Name
Last Name
Company
Subscribe in XML format
RSS 2.0
Atom 0.3
 

Stylus Studio has published XML-DEV in RSS and ATOM formats, enabling users to easily subcribe to the list from their preferred news reader application.


Stylus Studio Sponsored Links are added links designed to provide related and additional information to the visitors of this website. they were not included by the author in the initial post. To view the content without the Sponsor Links please click here.

Site Map | Privacy Policy | Terms of Use | Trademarks
Free Stylus Studio XML Training:
W3C Member
Stylus Studio® and DataDirect XQuery ™are products from DataDirect Technologies, is a registered trademark of Progress Software Corporation, in the U.S. and other countries. © 2004-2013 All Rights Reserved.