Javadoc的好例子

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

我可以在互联网上find很多Javadoc的例子,我只想找出用来创build它们的特定语法,并且假设我可以在某个图书馆的某个地方挖掘出一些东西,但这看起来像是很多工作。

JDK源代码如何,但通过像docjar第三方访问? 例如, collections源 。

这样,没有大的下载。

页面如何为Javadoc工具编写Doc Coments包含许多很好的示例。 一个部分被称为文档评论的例子,并包含相当多的用法。

此外, Javadoc常见问题包含更多的例子来说明答案。

JDK源代码如何?

我使用一小组文档模式:

  • 始终logging有关线程安全的信息
  • 始终logging不变性
  • javadoc与例子(如Formatter )
  • @Deprecation与WHY和如何replace注释元素

看看Spring框架的源代码,它有很好的javadocs

ant例如 – 在线浏览源代码: http : //svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/DefaultLogger.java? view=co

select其他文件从http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/?pathrev=761528

如果您使用的是Eclipse ,那么您可以在已安装的JRE中设置您的JDK (不是JRE ),然后使用Open TypeCtrl + Shift + T ),给java.util.Collections

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

如果您安装了JDK并select安装源代码,则src.zip包含所有公共Java类的源代码。 这些大多数都有相当不错的javadoc。

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

如果你所寻找的是语法,那么这可能会有所帮助:

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