<Swing Dev> 6179357: Generics: JList: generic code in Javadoc

Pavel Porvatov Pavel.Porvatov at Sun.COM
Wed Apr 8 09:38:28 UTC 2009


Hi Florian,

> you added a comment to the issue, that you prefer the *<code>* tag for large code fragments instead 
> of the *{@code* tag.
> 
> The advantage of the *{@code* tag is however that it escapes the angle brackets of generic code 
> statements, while with the *<code>* tag, one has to escape the angle brackets explicitly, which 
> makes the Javadoc in the source files much less readable.
> 
> So what do you recommend for large generic code fragements:
> 1. *{@code*
> 2. *<code>* and explicitly escaped angle brackets
> 3. ...
Oops. You are right. In this case the *{@code* tag will be much better. 
So don't replace the *{@code* tag by the *<code>* tag.

Thanks, Pavel.



More information about the swing-dev mailing list