Comments on: A Tip for Writing Better Javadoc http://www.breakitdownblog.com/a-tip-for-writing-better-javadoc/ A technical, gaming and current-events news site Sat, 21 Nov 2009 15:00:42 -0500 http://wordpress.org/?v=2.8.6 hourly 1 By: Paul Holser http://www.breakitdownblog.com/a-tip-for-writing-better-javadoc/comment-page-1/#comment-4362 Paul Holser Sun, 22 Apr 2007 18:25:34 +0000 http://www.breakitdownblog.com/2007/04/21/tips-to-writing-better-javadoc/#comment-4362 Note also that since Java 5 you can use {@code} instead of the actual HTML code tags -- helps cut back on clutter. Note also that since Java 5 you can use {@code} instead of the actual HTML code tags — helps cut back on clutter.

]]> By: Riyad Kalla http://www.breakitdownblog.com/a-tip-for-writing-better-javadoc/comment-page-1/#comment-4354 Riyad Kalla Sun, 22 Apr 2007 03:46:14 +0000 http://www.breakitdownblog.com/2007/04/21/tips-to-writing-better-javadoc/#comment-4354 Josh, very cool tip. Thanks for posting that. Josh, very cool tip. Thanks for posting that.

]]> By: Josh http://www.breakitdownblog.com/a-tip-for-writing-better-javadoc/comment-page-1/#comment-4353 Josh Sun, 22 Apr 2007 03:39:37 +0000 http://www.breakitdownblog.com/2007/04/21/tips-to-writing-better-javadoc/#comment-4353 Another nice feature of @link is that you can specify the text of the link: it doesn't have to be the method. For example, you can write: /** * The method for computing foo is described {@link #foo(int, long, float) here}. */ `Here' will be the clickable text. Another nice feature of @link is that you can specify the text of the link: it doesn’t have to be the method. For example, you can write:

/**
* The method for computing foo is described {@link #foo(int, long, float) here}.
*/

`Here’ will be the clickable text.

]]> By: Riyad Kalla http://www.breakitdownblog.com/a-tip-for-writing-better-javadoc/comment-page-1/#comment-4350 Riyad Kalla Sat, 21 Apr 2007 21:50:08 +0000 http://www.breakitdownblog.com/2007/04/21/tips-to-writing-better-javadoc/#comment-4350 Ganeshji, Me too, I had @see annotations at the ends of long Javadoc segments and always wished I could get some nice liking going on inside the doc without embedding URLs. I'm glad it helped! Ganeshji,
Me too, I had @see annotations at the ends of long Javadoc segments and always wished I could get some nice liking going on inside the doc without embedding URLs.

I’m glad it helped!

]]> By: Ganeshji Marwaha http://www.breakitdownblog.com/a-tip-for-writing-better-javadoc/comment-page-1/#comment-4348 Ganeshji Marwaha Sat, 21 Apr 2007 18:39:43 +0000 http://www.breakitdownblog.com/2007/04/21/tips-to-writing-better-javadoc/#comment-4348 Thanks for the info... I was always wrongly using the @see tag for this purpose --- until now. ;) Thanks for the info… I was always wrongly using the @see tag for this purpose — until now. ;)

]]>