Javadoc的好例子

时间:2009-07-03 14:54:01

标签: java javadoc

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

我可以在互联网上找到很多很好的Javadoc示例,我只想找出用于创建它们的特定语法,并假设我可以在某处找到某些库的源代码,但这似乎很多工作

11 个答案:

答案 0 :(得分:112)

JDK源代码怎么样,但是通过像docjar这样的第三方访问?例如,Collections source

这样,没有大的下载。

答案 1 :(得分:37)

页面How to Write Doc Coments for the Javadoc Tool包含大量优秀示例。一个部分称为Examples of Doc Comments,包含很多用法。

此外,Javadoc FAQ还包含一些示例来说明答案。

答案 2 :(得分:9)

JDK源代码怎么样?

答案 3 :(得分:5)

我使用了一小组文档模式:

  • 始终记录线程安全
  • 始终记录不变性
  • 带有示例的javadoc(例如Formatter
  • @Deprecation with WHY and HOW如何替换带注释的元素

答案 4 :(得分:4)

看一下Spring框架源码,它有很棒的javadocs

答案 5 :(得分:3)

答案 6 :(得分:2)

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

答案 7 :(得分:2)

如果您使用 Eclipse ,则可以在已安装的JRE 中设置 JDK (而不是 JRE ) ,然后使用 打开类型 Ctrl + Shift + T ),给像java.util.Collections

这样的东西

答案 8 :(得分:2)

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

答案 9 :(得分:1)

如果您要查找的只是语法,那么这可能会有所帮助:

How to Write Doc Comments for the Javadoc Tool

答案 10 :(得分:1)

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