Javadoc的好例子

140

有一个包含Javadoc的源文件的好例子吗？

我可以在Internet上找到很多很好的Javadoc示例，我只是想找出创建它们的特定语法，并假设我可以在某个地方浏览某些库的源代码，但这似乎需要很多工作。

java javadoc

— 杰森·S
source

118

JDK源代码如何，但是可以通过诸如docjar之类的第三方访问呢？例如，“ 收藏夹”源。

这样，就无需大量下载。

— 加里·F
source

1

这是一个很好的答案，因为Josh和Neal撰写的收藏集。

— cherouvim

我的防病毒软件说docjar链接不安全。您是否知道其他具有馆藏资源的网站？（如果这不是一个交通流量很高的问题，我会让它滑下来：）

— Gordon Gustafson 2013年

2

如果在Windows上，则JDK安装将包含src.zip带有标准库源代码的文件。

— Sri Harsha Chilakapati 2014年

第三方分发受版权保护的代码如何合法？还是版权允许？

— ThePyroEagle，2013年

这是外部链接的主要问题，“每个人的Docjar.net都关闭了”。

— 宙斯之书'18

39

“ 如何为Javadoc工具编写文档注释 ”页面包含许多良好的示例。其中一部分称为文档注释示例，其中包含许多用法。

另外，Javadoc FAQ包含更多示例来说明答案。

— 贾里德·奥伯豪斯（Jared Oberhaus）
source

固定链接（目前）： oracle.com/technetwork/java/javase/documentation/…–

— Jeff Evans

9

如何在JDK源代码？

— 炸鸡
source

那是我显而易见的想法，但我必须下载整个大混乱。:-(

— Jason S

5

您可能已经拥有了它，因为它是JDK附带的（尽管它是一个安装选项）。

— Michael Borgwardt

5

我使用了少量的文档模式：

总是记录有关线程安全的信息
始终记录不变性
带有示例的Javadoc（例如Formatter）
@弃用WHY和HOW替换带注释的元素

— dfa
source

包含如何替换已弃用的thx的绝佳提示

— Tobi Tiggers

4

看看Spring框架源代码，它具有出色的javadocs

— 盖尔·马齐乌（GaëlMarziou）
source

3

例如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

— 尼克·福特斯库
source

2

下载Lucene的资源，看看他们是如何做到的。他们有很好的JavaDocs。

— 里奇·欣德尔
source

2

如果您使用的是Eclipse，则可以在Installed JRE中设置JDK（不是JRE），然后使用Open Type（+ + ），输入以下内容：CtrlShiftTjava.util.Collections

— 克里斯·巴拉卡（KrishPrabakar）
source

1

补充说明一下，大多数IDE在配置JDK以供使用时会自动配置javadocs和source。这不仅适用于Eclipse。

— ThePyroEagle，2013年

2

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

— 马文·弗洛姆霍尔德
source

1

如果安装JDK并选择也安装源，则src.zip包含所有公共Java类的源。其中大多数都具有相当不错的javadoc。

— ThorbjørnRavn安徒生
source

1

如果您只是寻找语法，那么这可能会有所帮助：

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

— 杰西
source

1

谢谢，虽然已经知道了（请参阅我的问题）

— Jason S

重复答案而未提供其他有用信息。

— 阿列克谢·伊凡诺夫