xsl-list
[Top] [All Lists]

Re: [xsl] XSL - Documentation

2009-05-15 04:13:00
Am 13.05.2009 um 15:51 schrieb Tony Graham:

With GTK-Doc, structured comments in C code get turned into HTML
documentation.


While following this thread I learned a lot from the discussions.

A documentation framework that (it seems) wasn't mentioned is <http://doxsl.sourceforge.net/ >. I found a bookmark but have not tested it. It seems to use custom elements and comes with premade stylesheets to produce output.

For my projects I am looking at structured comments together with some »lightweight markup language« <http://en.wikipedia.org/wiki/Lightweight_markup_language >. Mainly because most projects also include XML files, and I can add comments even to output XML files without any need to modify the DTD/ XSD.

My question: Are there any standards for marking a "structured" XML comment?

I am not talking about the comment’s content, just how to easily differentiate a structured comment from a simple comment. My first ideas would be:

<!--/** ... -->
<!--//  ... -->
<!---   ... --->
<!--[   ... ]-->

- Michael

--
_______________________________________________________________
Michael Müller-Hillebrand: Dokumentation Technology
Adobe Certified Expert, FrameMaker
Consulting and Training, FrameScript, XML/XSL, Unicode
Blog [de]: http://cap-studio.de/




--~------------------------------------------------------------------
XSL-List info and archive:  http://www.mulberrytech.com/xsl/xsl-list
To unsubscribe, go to: http://lists.mulberrytech.com/xsl-list/
or e-mail: <mailto:xsl-list-unsubscribe(_at_)lists(_dot_)mulberrytech(_dot_)com>
--~--

<Prev in Thread] Current Thread [Next in Thread>