【问题标题】:Looking for good example of Java code that has Javadoc comments寻找具有 Javadoc 注释的 Java 代码的好例子
【发布时间】:2011-06-23 08:11:50
【问题描述】:

我一直在对一些代码运行 Checkstyle,并寻找一个很好的示例来掌握如何为特定目的添加 cmets。

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

我在各个地方寻找,但找不到一个简洁的例子...... 1 2 3 4 5

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

here

我该怎么做:

1) 获取日历的源代码?

2) 找到一个示例,说明如何在 Javadoc 中记录这样的代码(Checkstyle flags it needs it):

private static final int NO_OF_RECORDS = 10;

【问题讨论】:

  • 哇,java.util.Calendar 被引用为一个 good 示例...
  • 这是一个堆栈溢出错误!开放 ID 糟透了!

标签: java comments javadoc


【解决方案1】:

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

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

【讨论】:

  • 感谢您唤醒我的记忆。有一个 src.jar 文件,如果您愿意,您也可以在 IDE 外部解压缩并查看它......(至少它曾经在 Snow Leapard 上,直到大约 1.6.6/10.6.6)。我在安装后和运行软件更新之前立即获取了一份副本。我已经忘记了这一切! :-)
【解决方案2】:

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

【讨论】:

    猜你喜欢
    • 2011-02-07
    • 2010-10-07
    • 2023-03-04
    • 2012-02-23
    • 2010-11-07
    • 1970-01-01
    • 2011-02-15
    • 2010-10-14
    相关资源
    最近更新 更多