2011-02-08 56 views
0

我一直在对一些代码运行Checkstyle并寻找一个很好的示例来了解如何为特定目的添加注释。寻找具有Javadoc评论的Java代码的好例子

例如Checkstyle说我应该为常量/类变量添加注释。然而,Oracle官方文档中没有任何地方可以找到这方面的例子。

我一直在寻找在不同的地方,却找不到一个简洁的例子... 1 2 3 5

我想如果我能得到我的手源代码对于Java日历类,这将是一个很好的例子。您可以在该类的API文档中查看各种常量。

参见here

如何,我不是:

1)让我的手源日历上?

2)找到如何你会在Javadoc中记录这样的代码示例(Checkstyle的标志,它需要它):

private static final int NO_OF_RECORDS = 10;

+1

哇,`java.util.Calendar`被引用作为*良好*例如一次... – 2011-02-08 10:24:16

+0

这是一个堆栈溢出漏洞!打开标识很烂! – JGFMK 2011-02-08 10:26:43

回答

3

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

此外,大多数IDE自动索引Java的类库的源代码,这样就可以透明地打开这些类。