[EMAIL PROTECTED] wrote:
On 1/3/06, Bob Harner <[EMAIL PROTECTED]> wrote:
As for comments within files, it might be worthwhile to more carefully
consider how this is structured, rather than just putting plain text
inside of comment tags. It would be nice to have the internal
documentation in these files be extractable (someday) by a program, in
the same way that javadoc documentation is easily extractable from
java source code. See
http://www.codeproject.com/soap/xsltdocumentor.asp an example of such
a program for XSLT files in particular. Does anyone else have any
suggestions in this area? We will need a syntax for documenting xslt
and xmap files especially.
You inspired me.
http://solprovider.com/lenya/xsltdoc
Is that a useful start? It does not expect any special tags, but we
could parse comments to decide how or if to display them. Some of my
test files have code commented out, and having the obsolete code in
the documentation is annoying.
sexy. ++votes.
how about cloning javadoc's syntax and combining it with the categories
i proposed earlier (see
http://wiki.apache.org/lenya/CategoriesForFileDocumentation) ?
i.e. an xmldoc comment could look like this:
<!---
- @parsed_during page request
- @modification_by_admin mandatory
-
-->
or maybe
<!--* @<category> <content>
* @<category> <content>
*-->
?
--
"Open source takes the bullshit out of software."
- Charles Ferguson on TechnologyReview.com
--
Jörn Nettingsmeier, EDV-Administrator
Institut für Politikwissenschaft
Universität Duisburg-Essen, Standort Duisburg
Mail: [EMAIL PROTECTED], Telefon: 0203/379-2736
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
