good example of Javadoc

Question

is there a good example of a source file containing Javadoc?

I can find lots of good examples of Javadoc on the internet, I would just like to find out the particular syntax used to create them, and assume I can pore through the source of some library somewhere but that seems like a lot of work.

Answer 1

How about the JDK source code?

Answer 2

Download the sources of Lucene and see how they do it. They have good JavaDocs.

Answer 3

How about the JDK source code, but accessed through a 3rd party like docjar? For example, the Collections source.

That way, there's no big download.

Answer 4

I use a small set of documentation patterns:

• always documenting about thread-safety
• always documenting immutability
• javadoc with examples (like Formatter)
• @Deprecation with WHY and HOW to replace the annotated element

Answer 5

The page How to Write Doc Coments for the Javadoc Tool contains a good number of good examples. One section is called Examples of Doc Comments and contains quite a few usages.

Also, the Javadoc FAQ contains some more examples to illustrate the answers.

Answer 6

ANt for example - source code browsable online: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/DefaultLogger.java?view=co

To choose other files start from: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/?pathrev=761528

Answer 7

If all your looking for is the syntax, then this may help:

http://java.sun.com/j2se/javadoc/writingdoccomments/[1]

Answer 8

If you install a JDK and choose to install sources too, the src.zip contains the source of ALL the public Java classes. Most of these have pretty good javadoc.

Answer 9

Have a look at Spring framework source, it has excellent javadocs