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

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

• To: <bill.dehora@p...>
• Subject: RE: Documenting XSLT (Was: Note from the Troll)
• From: "bryan" <bry@i...>
• Date: Tue, 29 Oct 2002 12:13:24 +0100
• Cc: <xml-dev@l...>
• Importance: Normal
• In-reply-to: <00e001c27f3a$250f36e0$1fc8c8c8@mitchum>

Bill de hÓra wrote
>IMO, not having a documentation element in XSLT is a bonus for
>debugging. The only thing developers are worse at than developing is
>documenting what they develop. 

I have to agree there, aside from the fact that there is a reasonably
well known convention of using namespaced elements in XSLT to handle
documentation - http://www.jenitennison.com/xslt/utilities/paramDoc.html
-
Most documentation I see, of whatever sort, is absurd. Along the lines
of 

<!--pass the parameter myparam to dostuff template-->
<xsl:call-template name="dostuff">
<xsl:with-param name="myparam" select="$myparam"/>
</xsl:call-template>

documentation usually seems to me only to be useful when it is an
external document describing the process as a whole.

• References:
  • RE: Documenting XSLT (Was: Note from the Troll)
    • From: Bill de hÓra <bill.dehora@p...>

• Prev by Date: RE: Documenting XSLT (Was: Note from the Troll)
• Next by Date: Re: Not quite an I-D announcement
• Previous by thread: RE: Documenting XSLT (Was: Note from the Troll)
• Next by thread: Re: Documenting XSLT (Was: Note from the Troll)
• Index(es):
  • Date
  • Thread