寻找具有 Javadoc 注释的 Java 代码的好示例
我一直在一些代码上运行 Checkstyle,并寻找一个很好的示例来掌握如何为特定目的添加注释。
例如,Checkstyle 说我应该为常量/类变量添加注释。然而,在 Oracle 主机的官方文档中,我找不到这方面的示例。
我在各个地方寻找,但找不到简洁的例子...... 1 2 3 4 5
我想如果我能得到 Java Calendar 类的源代码,这将是一个很好的例子。您可以在该类的 API 文档中看到各种常量。
请参阅此处。
我怎样才能:
1)获取日历的源代码?
2)找到一个示例,说明如何在 Javadoc 中记录这样的代码(Checkstyle 标记它需要它):
<代码> 私有静态最终 int NO_OF_RECORDS = 10;
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;
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(2)
在 Java 6 下载页面 上的“其他资源”下部分,您可以下载整个 JDK 的源代码。
此外,大多数 IDE 会自动索引 Java 库类的源代码,以便您可以透明地打开这些类。
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.
Oracle 当前的 java 6 源代码下载链接为 http://download.java.net/jdk6/source/ 其中应该包含整个 java 库源代码。
Oracle's current java 6 source download links to http://download.java.net/jdk6/source/ which should contain the entire java library source.