Javadoc的好例子

Question

有没有一个包含Javadoc的源代码文件的好例子？

我在网上找到了许多很好的Javadoc示例，我只是想找到用于创建它们的特定语法，并假设我可以浏览某个库的源代码，但那似乎需要很多工作。

- Jason S

Answer 1

如何看待通过像docjar这样的第三方工具访问JDK源代码？例如，Collections源代码。 这样做的好处是不需要进行大量的下载。

- GaryF

---

这是一个很好的答案，因为集合是由Josh和Neal编写的。 - cherouvim

我的防病毒软件说docjar链接不安全。你知道还有哪些网站可以提供集合源代码吗？（如果这不是一个相当高流量的问题，我可能会放过它 :)） - Gordon Gustafson

如果您使用的是Windows操作系统，JDK安装包中包含一个名为src.zip的文件，其中包含标准库的源代码。 - Sri Harsha Chilakapati

第三方如何合法分发受版权保护的代码？或者版权允许这样做吗？ - ThePyroEagle

这是外部链接的主要问题，“Docjar.net对所有人都不可用。” - Book Of Zeus

Answer 2

网页如何为Javadoc工具编写文档注释包含许多良好的示例。 其中有一部分叫做文档注释示例，其中有相当多的用法。

Javadoc FAQ也包含了一些更多的示例以说明答案。

- Jared Oberhaus

---

固定链接（暂时）：http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html - Jeff Evans

Answer 3

关于JDK源代码怎么样？

- butterchicken

---

这是我显而易见的想法，但我必须下载整个混乱的东西。 :-( - Jason S

有可能你已经拥有它了，因为它随着JDK一起提供（尽管它是一个安装选项）。 - Michael Borgwardt

Answer 4

我使用一小组文档模式：

• 始终记录线程安全
• 始终记录不可变性
• javadoc带有示例（例如Formatter）
• @Deprecation带有为什么和如何替换注释元素的说明

- dfa

---

很好的提示，包括如何替换已弃用的内容，谢谢。 - Tobi Tiggers

Answer 5

看一下Spring框架源码，它有非常好的Javadoc文档。

- Gaël Marziou

Answer 6

Google Guava的EventBus包和类的文档是Javadoc的一个很好的例子。特别是带有快速入门指南的包文档写得很好。

- Marvin Frommhold

Answer 7

例如ANT - 源代码可在线浏览：http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/DefaultLogger.java?view=co 要选择其他文件，请从以下链接开始：http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/?pathrev=761528

- Nick Fortescue

Answer 8

下载Lucene源代码并查看它们的实现方式。它们有很好的JavaDocs。

- RichieHindle

Answer 9

如果你只是想找语法的话，那么这可能有帮助：

如何为Javadoc工具编写文档注释

- Jesse

---

谢谢，我已经知道了（请看我的问题）。 - Jason S

未提供其他有用信息的重复答案。 - Alexey Ivanov

Answer 10

如果您正在使用Eclipse，则可以在已安装的JRE中设置您的JDK（而不是JRE），然后使用打开类型（Ctrl+Shift+T），输入类似于java.util.Collections的内容。

- KrishPrabakar

---

补充一下，大多数集成开发环境在配置JDK时会自动配置javadocs和源代码。这不仅适用于Eclipse。 - ThePyroEagle