有没有包含Javadoc的源文件的好例子?
我可以在互联网上找到很多很好的 Javadoc 示例,我只想找出用于创建它们的特定语法,并假设我可以在某个地方仔细研究某个库的源代码,但这似乎需要做很多工作。
JDK 源代码如何,但通过 docjar 之类的第 3 方访问?例如,集合源。
这样,就没有大的下载。
How to Write Doc Comments for the Javadoc Tool页面包含大量很好的示例。一个部分称为文档注释示例,其中包含相当多的用法。
此外,Javadoc FAQ包含更多示例来说明答案。
JDK源代码怎么样?
我使用一小组文档模式:
看看 Spring 框架源码,它有优秀的 javadocs
例如 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
下载Lucene的源代码,看看他们是如何做到的。他们有很好的 JavaDocs。
如果您使用的是Eclipse,那么您可以在Installed JREs中设置您的JDK(不是JRE),然后使用Open Type ( ++ ) ,给出类似CtrlShiftTjava.util.Collections
Google Guava 的EventBus包和类的文档是 Javadoc 的一个很好的例子。特别是带有快速入门的包文档写得很好。
如果您要寻找的只是语法,那么这可能会有所帮助:
如果您安装 JDK 并选择安装源代码,则 src.zip 包含所有公共 Java 类的源代码。其中大多数都有很好的javadoc。