如何为类的单独枚举值编写Javadoc文档
我正在为一个包含枚举的类编写 Javadoc。是否有一种方法可以为单独的枚举生成 Javadoc？例如，现在我有像这样的东西：/** * This documents "HairColor" */ private static enum HairColor { BLAC...
Javadoc重用对于重载方法
我正在开发一个API，其中有许多仅通过签名不同的方法，这似乎是相当常见的。除非用户想要指定，否则它们都会执行相同的操作，但它们会通过默认值初始化各种值。作为一个易于理解的示例，请考虑public interface Forest { public Tree addTree(); pu...
我应该使用JavaDoc中的过时提示还是Java中的注释？
目前有两种方法可以在Java中将代码标记为已弃用。 通过JavaDoc标记/** * @deprecated */ 或者作为注释：@Deprecated 这是我的问题-当在Eclipse中将方法标记为已弃用时，我觉得声明两个有点过于繁琐。 我真的只想使用其中一个。 但是，使用注释会给编...
是否有一些好的、现代化的替代Javadoc的工具？
面对现实吧：没必要是一名设计师，也能看出默认的文档看起来很丑陋。 尽管网上有一些重新样式化的 文档资源，但默认行为应该代表产品，并且应该是相当好看的。 另一个问题是，与其他类似资源相比，的可用性已经不再更新。 特别是在使用Firefox的快速搜索时，非常大型的项目难以导航。 实践问题：...
如何在Eclipse中为任何jar文件（例如JavaFX）附加源代码或JavaDoc？
我目前正在使用JavaFX。每当我悬停在JavaFX方法上时，它会给出以下错误： '注意：此元素既没有附加源代码也没有附加Javadoc，因此找不到Javadoc' 我该如何解决这个问题？我该如何附加Javadoc或源代码以便查看方法的描述？
JDK 11+中Javadocs缺少iFrame视图
我一直在使用 JDK 11的JavaDocs 但是我注意到iFrames视图似乎不再可用。我搜索了一下，但没有找到关于这个问题为何被处理以及是否有其他的替代方案的任何细节。能否有人提供更多详细信息？ JDK 10的视图 JDK 11的视图
如何在Eclipse中将包含javadoc/source的jar文件与其二进制文件进行关联？
我希望当我在eclipse中将鼠标悬停在类上时，能够显示jar文件中包含的javadoc注释。例如，在下载JODA-2.0后会得到三个jar文件： joda-time-2.0 joda-time-2.0-javadoc joda-time-2.0-sources (http://sourc...
Javadoc @author 标签的最佳实践
我想了解创建Javadocs的最佳实践。我有一个由许多开发者创建的项目，其中包含许多文件。每个文件都有一个注释@author，因此很明显是谁创建了特定的类。 但是，当其他开发人员向文件添加新代码，修改它等等时，他应该如何通知团队其已创建了一些新功能或已修改了现有代码？换句话说，我们应该如何“...
Javadoc链接到另一个包中的类
我有两个包，Shapes 和 Fruits:com.myproject.Shapes. Circle Square Triangle com.myproject.Fruits. Apple Orange 我正在为Apple编写JavaDoc，并需要提供一...
Eclipse生成Javadoc向导：什么是“Javadoc命令”？
我想为我使用的开源代码生成javadoc文档。但是在Eclipse生成JavaDoc向导中，它要求我输入“Javadoc命令”，而帮助文件没有解释这是什么意思。它是要求我提供javadoc二进制/ jar文件的路径还是其他内容？