views:

253

answers:

1

Unfortunately, there is no CDATA in HTML.

This is a pity, because it would be perfect for adding javadoc comments that include XML, so you don't have to escape the < and >, for example:

/**<![CDATA[ This parses <complexType name=""> ]]>*/

However, it would be possible for javadoc to recognize the CDATA section, and convert it to HTML for you. For example:

This parses &lt;complexType name=""&gt;

Or it could use some simpler syntax than CDATA. Because javadoc is extensible, it's possible someone has added this functionality; or maybe javadoc already has it buried somewhere inside... Does anybody know?

+8  A: 

You can use JavaDoc's @code tag: /** This parses {@code <complexType name="">} */

Fabian Steeg
+1Note that {@code ... } can span multiple lines. eclipse will claim it's an error, but it's not. It also does brace-counting! So you can use curlies in your actual code snippet, as long as they match up.
Kevin Bourrillion