问题标签 [javadoc]

我一直想知道如何记录一个覆盖来自基类的消息的方法。通常我会为每个公共方法和一些私有的受保护方法添加一个 java 文档。

但是在 eclipse 中为覆盖方法自动生成一个文档块会产生这样的结果：

这是记录覆盖的好方法吗？我应该从基类继承/复制文档吗？

作为这种特殊情况的文档，您在做什么？我想对所使用的做法进行概述。

就像是：

我有一个仅包含类文件的 jar 形式的第三方库。

我希望能够运行 javadoc（或其他一些工具）并生成对我可以进行的库 API 调用的引用。

我知道我不会得到很多有用的评论，但我并不期待。我只想要自动生成的类和调用摘要。

这样做的最佳方法是什么？

编辑：和 jad 一样好，它不会生成完美的代码。因此，javadoc 抱怨。有没有办法告诉 javadoc 忽略错误并尽可能生成文档？

我有多个程序员为 javadocs 提供示例，一些示例包含格式为的注释

当我将这些示例放入 javadoc 注释时，示例中的注释关闭了 javadoc 注释。

有没有适当的方法来处理这个问题，而不告诉每个人他们不能用这种格式写评论？

我正在使用javadocAnt 任务生成的 javadocs 来记录 Web 服务，并且我想从输出中排除一些构造函数。我怎么做？

我在 Util 类中写了两个方法：

方法 copy2 的 Javadoc 包括：

作为测试还包括：

当我单击最高的OneBit 链接时，它可以工作。当我单击复制链接时，它无法正常工作，它链接到 Util 类？！Java 版本 1.5.0_16。

我是GhostDoc在 Visual Studio 中自动生成注释的忠实粉丝，所以我正在寻找一个插件，它可以在 Eclipse 中对我的 Java 代码执行相同的工作。有什么建议吗？

我知道可以使用 '<alt><shift>J' 为单个代码元素（例如类方法）创建标签。

但是有没有办法为整个项目中的每个类自动创建这些标签？甚至只是在包或类级别？

在isValid(int)from java.sql.Connection（接口）的文档中：

http://java.sun.com/javase/6/docs/api/java/sql/Connection.html#isV​​alid(int)

它声明它将抛出一个“SQLException如果提供的值timeout小于 0”。

实现者是否应该将其解读为“SQLException 当且仅当所提供的值timeout小于 0”，或者他们是否也可以出于一系列其他原因随意扔掉它？

编辑：我想我很困惑/恼火他们为什么不使用IllegalArgumentException. 我希望SQLException指的是“数据库似乎已经融化”之类的东西，而不是“你对这个论点有一个基本的误解”。

我有一种情况，我想在一个没有类的项目中执行 javadoc。它只有一个包的 package-info.java。执行javadoc时，报错如下：

有没有办法强制它只处理 package-info.java （除了明显的 hacky 解决方案：创建一个虚拟类，编写 package.html 的复制脚本等）？

我正在执行 javadoc 作为 maven 构建的一部分，因此 maven-javadoc-plugin 正在执行实际的 javadoc 命令。