howto use code examples, <pre> or <code>

i want to drop some code examples in my javadoc.i am currently using <pre> which works since it is html but is there another tag?i have found nothing in the javadoc manual.thnx

[224 byte] By [turbobutton] at [2007-9-27 2:28:02]

«« Some questions
»» help with date validation on input boxes.

# 1

<pre> is correct for formatting code examples properly.

In 1.4.0, you can even omit the leading asterisks (*)

so that you can just paste examples into doc comments.

There is no standard tag, such as @example, for including

examples, though you could create one in 1.4.0 using

-tag or -taglet.

-Doug Kramer

Javadoc team

dkramer at 2007-7-4 22:01:56 >

top of Java-index,Developer Tools,Debugging and Profiling Tool APIs...

# 2

thanks for the reply. i did notice defining custom tags in new spec. is xml in the pipeline?cheers

turbobutton at 2007-7-4 22:01:56 >

# 3

You mean an XML version of the API documentation, generated by an XML doclet? This is something we'd like to produce, but probably won't get to it in the next year.-Doug

dkramer at 2007-7-4 22:01:56 >

# 4

yes, something like that. it would be interesting to search for libraries, packages, individuals classes themselves. just a thought.

turbobutton at 2007-7-4 22:01:56 >

Java programming resources: FAQs, tutorials, compiler and browser download sites, documentation, books lists, IDEs, etc.

howto use code examples, <pre> or <code>

Developer Tools New Topic

Developer Tools Hot Topic

Developer Tools

All Classified