Marc, himself, his blogs, and you reading them.
October 20, 2005
Huh! There must be a better reason why we all are adding these dreadfull hand-typed <my><xml><snippet/></xml></my> blurps to our /** javadoc sections describing useful xml config */ while we would just rather use <![CDATA[<my><xml><snippet/></xml></my>]]>, no?
The one reason I've found is that the javadoc tool will enter your CDATA sections as comments in the resulting HTML, not as the verbatim copy of what you want to see. Bummer!
update: Just wasted a 'vote' on a reported bug that seems related and useful.
# Posted by mpo at 02:54 PM | TrackBackCould you please switch the RSS feed to have the full postings instead of just the first lines? I cannot read your blog while on the go.
Thanks :-)
Posted by: Nicola Ken Barozzi at October 20, 2005 05:38 PMhehe,
I've found it easier to remember the helps me remember the amount and type of braces to use.)
Posted by: -marc= at October 20, 2005 05:40 PMYou can also place your example XML files in a 'doc-files' subdirectory and then link to them as follows in your javadoc:
* <a href="doc-files/example.xml">View example XML configuration</a>
*
For details google on javadoc doc-files.
Posted by: Jeoff Wilks at November 18, 2005 09:06 PMYou can also place your example XML files in a 'doc-files' subdirectory and then link to them as follows in your javadoc. For details google on javadoc doc-files.
Posted by: Jeoff Wilks at November 18, 2005 09:07 PM
Personally I tend to avoid <![CDATA[ because I can never remember whether it's spelled <![CDATA[ rather than <[!CDATA[ or <[CDATA![ or some other variant ;)
Posted by: Ugo Cei at October 20, 2005 05:29 PM