Javadoc 的好例子

是否有一个包含 贾瓦多克的 源文件的好例子？

我可以在互联网上找到很多很好的 Javadoc 例子，我只是想找出用于创建它们的特定语法，并假设我可以在某个地方钻研某个库的源代码，但这似乎有很多工作要做。

343192 次浏览
小开

JDK源代码怎么样？

小开

下载 Lucene的源代码，看看他们是怎么做的。

小开
最佳答案

JDK 源代码如何，但是通过像 docjar 这样的第三方访问。

那样的话，就不会有大量下载了。

小开

我使用一小组文档模式:

  • 总是记录线程安全性
  • 总是记录不变性
  • Javadoc 和示例(如 Formatter)
  • @ 不赞成用“为什么”和“如何”替换带注释的元素
小开

如何为 Javadoc 工具编写 Doc 注释页面包含了大量的好例子。其中一个部分称为 文档注释示例，包含相当多的用法。

此外，Javadoc 常见问题解答还包含了一些更多的例子来说明答案。

小开

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

小开

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

如何为 Javadoc 工具编写 Doc 注释

小开

如果您安装一个 JDK 并选择安装源代码，src.zip 包含所有公共 Java 类的源代码。大多数都有很好的 javadoc。

小开

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

小开

如果你使用的是 日食，那么你可以在 已安装 JRE中设置你的 JDK(而不是 JRE) ，然后使用 < em > 开放式(Ctrl + Shift + T) ，给出类似于 java.util.Collections的东西

小开

GoogleGuava 的 活动巴士包和类的文档是 Javadoc 的一个很好的例子。特别是快速启动的包文档写得很好。


提交答案