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

标签 java comments javadoc

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

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

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

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

参见here .

我怎样才能:

1) 获取日历的源代码?

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

私有(private)静态最终 int NO_OF_RECORDS = 10;

最佳答案

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

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

关于java - 寻找具有 Javadoc 注释的 Java 代码的好示例,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/4931824/

相关文章:

java - AspectJ 切入点到方法调用(即使它是在外部库上调用的)

java - 如何在 java 中解码 .csr 文件以提取其内容

java - 使用 Rhino 的 Javascript 解析器,如何获取注释?

Javadoc:如何修复: "bad HTML entity"错误

javadoc - Java 文档中的私有(private)成员变量

java - 是否有必要在构建过程中生成 javadoc?

java - 如何使用 RabbitTemplate 设置每条消息的 TTL?

java - Java 中的 k 叉树

comments - VIM : Trouble mapping <c-/> and re-selecting visual selection?

emacs - orgmode 中的注释行