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

Question

我已经在一些代码上运行了Checkstyle，并寻找一个很好的例子来掌握如何为特定目的添加注释。

例如，Checkstyle说我应该为常量/类变量添加注释。然而，在官方文档Oracle主机中，我找不到这样的例子。

我找了很多地方，但找不到一个简洁的例子……1 2 3 4 5

我想，如果我能拿到Java Calendar类的源代码，这将是一个很好的例子。您可以在该类的API文档中看到各种常量。

参见here。

​

我怎么也可以：

1)获得Calendar的源代码？

​

2)找到一个示例，说明如何在Javadoc中像这样记录代码(Checkstyle标记它需要它)：

private static final int NO_OF_RECORDS = 10;

Answer 1

在Java 6 download page上的“其他资源”部分，您可以下载整个JDK的源代码。

此外，大多数IDE会自动索引Java库类的源代码，因此您可以透明地打开这些类。

Answer 2

Oracle当前的java6源代码下载链接到http://download.java.net/jdk6/source/，它应该包含整个java库源代码。