问题标签 [javadoc]

我将 Eclipse 配置为在缺少公共元素的 javadoc 注释和标签时显示警告。这对我来说非常有用，可以很好地记录我的代码。

但有时我有一个类，我有几个常量描述例如 DFA 的状态或其他东西.. 没有必要记录这些常量，因为它们是不言自明的..

所以我在类中添加了注解@SuppressWarnings("javadoc")，这就是我的观点——Eclipse 不考虑注解并且仍然在缺少 javadocs 时显示警告。

@SuppressWarnings("all")完成了这项工作，但这有副作用，这是不希望的；-)

您是否遇到同样的问题？这是一个错误还是我只有配置错误的东西？有什么解决方法吗？或者这在新版本中是否得到纠正？

PS：我正在使用版本：3.3.2 Build id：M20080221-1800

我想查看 html 格式的 javadoc 但不希望它用于整个包，有什么方法可以做到这一点。

我希望 Eclipse 根据之前为字段定义的注释为我的 getter 和 setter 方法自动生成 Javadoc 注释。我怎样才能做到这一点？

背景：我们公司的一项政策是评论每个方法和字段（即使它们有不言自明的名称）。所以我必须通过描述字段并再次描述getter / setter来做多余的工作。

例子：

搜索网络表明我不是唯一一个有问题的人 - 但我找不到任何解决方案。我检查了http://jautodoc.sourceforge.net/但似乎它无法做到这一点。

我在这方面很难过！

我已将 java 文档安装在：

文件：///usr/share/doc/openjdk-6-jre/api/index.html

并且加载该文件确实向我显示了所有文档。

但是，当我将鼠标悬停在一个类上时，我想直接从 eclipse 中浏览它并查看文档。例如，当我将鼠标悬停在“javax.servlet.http.HttpServletRequest”上时，我想查看它的文档。我得到的是：

注意：此元素没有附加源，并且在附加的 Javadoc 中找不到 Javadoc。

任何人都可以帮助纠正我的开发环境吗？

让我们面对现实吧：您不需要成为设计人员就可以看到默认的Javadoc 看起来很丑。

网上有一些资源提供了重新设计的 Javadoc。但默认行为代表产品，应该是相当好看的。

另一个问题是，与其他类似资源相比，Javadoc 的可用性不是最新的。

特别是大型项目很难使用 Firefox 的快速搜索来导航。

实际问题：
是否有任何独立（桌面）应用程序能够以比浏览器更有用的方式浏览现有 Javadoc？
我正在考虑诸如 Mono 的文档浏览器之类的东西。

理论问题：
有谁知道，如果有一些计划以某种标准化的方式发展 Javadoc？
编辑： Sun' wiki 关于这个主题的有用链接。

您使用什么约定来评论 getter 和 setter？这是我很长时间以来一直想知道的事情，例如：

我总是发现我在为 1a/b 和 2a/b 写几乎完全相同的东西，比如 1a) 设置员工的薪水，1b) 员工的薪水。这似乎是多余的。现在我可以看到对于更复杂的东西，您可能会在 (a) 部分中写更多内容，以提供上下文，但对于大多数 getter/setter 而言，措辞几乎完全相同。

我只是好奇，对于简单的 getter/setter 是否可以只填写 (a) 部分或 (b) 部分。

你怎么看？

当我运行时mvn javadoc:javadoc，我收到以下错误：

当我在我的系统上调用该命令"C:\Program Files\Java\jdk1.6.0_14\jre..\bin\javadoc.exe"时，它会运行 javadoc 可执行文件。

我在跑步：

• JDK 1.6.0_14
• Maven 2.0.8

我的 POM 的 javadoc 报告部分如下所示：

以及相关的环境变量：

我尝试过重新安装 Java 和 Maven，以及使用 Maven 2.1.0、JDK 1.6.0_11，甚至 JDK 1.5.0_11。我将我的设置与一个环境几乎相同但没有问题的同事进行了比较。它曾经在大约一个月前工作，不，我不知道从那时起我的系统发生了什么变化。我第一次遇到它是在 JDK 1.6.0_11 中。这发生在我在我们的存储库中尝试过的每个项目上，我的同事对相同的项目没有任何问题。所以我很确定这只是我的环境，而不是项目本身。

我真的很感激对此的任何建议。

我有一个用于编码 URI 的便利类。在其中，我创建了三种方法，具体取决于我需要的具体程度。我想知道@param在这种情况下使用 JavaDoc 是否有一种聪明的方法来重用描述？（我还没有找到）

我最近开始使用 DocCheck 来检查代码文件中 JavaDoc 的有效性。

有没有办法将 DocCheck 设置为 Eclipse 插件？

有没有包含Javadoc的源文件的好例子？

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