寻找具有Javadoc注释的Java代码的好例子

Question

I've been running Checkstyle on some code and looking for a good example to get to grips with how to add comments for specific purposes.

For example Checkstyle says I should add comments for constants/class variables. Yet nowhere in the official docs Oracle host, can I find an example of this.

I was looking in various places, but couldn't find a concise example... 1 2 3 4 5

I figured if I could get my hands on the source code for the Java Calendar class, it would be a good example. You can see all sorts of constants in the API docs of that class.

See here .

How can I either:

1) Get my hands on the source for Calendar?

2) Find an example of how you'd document code like this in Javadoc (Checkstyle flags it needs it):

private static final int NO_OF_RECORDS = 10;

Answer 1

On the Java 6 download page , under the "additional resources" section, you can download the source code for the whole JDK.

Additionally, most IDEs automatically index the source code for Java's library classes so you can open those classes transparently.

Answer 2

Oracle当前的Java 6源下载链接到http://download.java.net/jdk6/source/ ，其中应包含整个Java库源。