问题标签 [inheritdoc]

覆盖另一个方法的方法不会继承它所覆盖的方法的文档。有没有办法明确告诉它继承文档？

当我{@inheritDoc}在 Eclipse 中使用时，超类的 javadoc 注释没有出现在我的类的 javadoc 中。

我有以下代码：

我确保该rt.jar库（其中包含javax.swing.table.AbstractTableModel）设置了源代码和 javadoc 位置，实际上，当我将鼠标悬停在工具提示中时，getRowCount()我得到了javadoc。AbstractTableModel当我从 Eclipse 生成 javadoc 时，我确保在“引用的档案和项目”部分中rt.jar被选中。但是继承文档不起作用。

我想使用{@inheritDoc}该类从我的抽象类继承方法。在抽象类的文档中，我按名称引用抽象类。我如何标记它，以便当子类从超类继承文档时，它将抽象类的名称替换为子类的名称？

我使用 Ant 任务为项目生成文档。在几个地方，我想从标准类继承文档，所以我使用{@inheritDoc}它允许我在 Eclipse 中查看 Javadoc，但它不会显示在 HTML 文件中。问题是我没有在源路径中包含解压缩的 src.zip（J2SE 源）。解决了这个问题后，我现在收到了数百条关于在文件中使用 Sun 专有 API 的警告lib/jdk-src/java/lang/Class.java。

有没有办法抑制这些警告？在这种混乱中很难找到相关的问题。

我想到的一个可能的解决方案是运行一次 Javadoc 任务，而不在源路径中包含 J2SE 源，这将揭示任何实际问题。然后我可以在包含 J2SE 源代码的情况下再次运行 Javadoc，完全丢弃输出，这将生成带有正常工作{@inheritDoc}s 的文档。我不完全确定在 Ant 中完成此任务的最佳方法，更不用说运行 Javadoc 两次将是一个肮脏的修复。

有什么建议么？

几个月来我一直在寻找答案，我尝试了多种方法，包括解压缩 Compressed 文件夹 src.zip 并将其用作 Javadoc 的参数（例如javadoc -sourcepath src com.example.test：）

这是 JDK 6 Update 24 附带的默认 Javadoc。

假设我正在开发一个实现java.util.Map接口的新地图。默认情况下，我从 Map 接口覆盖的方法应该从接口继承文档，如果我没记错的话。但是，javadoc 从不这样做。

到目前为止，唯一能解决这个问题的，实际上是对 Java 编写的类进行 javadoc-ing（例如：）javadoc com.example.text java.util。我不想这样做，因为它看起来像是我重写了 Java 类，但这是唯一的方法吗？如果是的话，我想我可以忍受它，但我的理解是还有另一种方法可以做到这一点。

谢谢=）如果这有点混乱，我很抱歉。这是我第一次使用 Stack Overflow。如果这个问题已经被问过，我也很抱歉。我已经阅读了许多类似的问题，因为它们并没有涵盖我想问的所有问题，而且我发现它们非常令人困惑，因为它们涉及编写您自己的 Javadoc 实现。无论如何，谢谢你先进=）

编辑：5 月 25 日 4:44

好的=）如果我理解正确，你想看一个例子。这是一个更简单的例子，我试图看看是不是因为我正在尝试一些不应该工作的东西。

我把这个例子（文件名是UpperCaseObject.java）移动到一个目录中javadoc-test/com/example，我还创建了另一个目录javadoc-test/java/lang，将Object.java（来自 src.zip）放入其中。

我对 javadoc 的调用来自目录。我的路径参数中有 jdk6 bin 目录。javadoc -link http://download.oracle.com/javase/6/docs/api/ com.examplejavadoc-test

我期望的两件事是UpperCaseObject.hashCode继承所有文档，以及UpperCaseObject.toString从java.lang.Object. 但是，不幸的是，我没有得到任何文档。

编辑：

好吧，我必须做的是以下事情。这只是一个简单的解决方法。

1. 我从 source.zip 中复制了所有源文件，就像您通常这样做一样。
2. 我还为每个包制作了包文件。它们包含第一段（带有摘要的段）和第二段，其中写着“有关更多信息，请参阅 Java™ 平台标准版 6 API 规范中的包摘要”。
3. 源文件本质上是超类、它们的超类（和接口），以及它们抛出的任何异常也都在同一个包中。唯一的例外是 java.lang，我只需要获取 Object。异常也是需要的，因为除了 java.lang 之外，如果异常与抛出类在同一个包中，则其他包不会链接。
4. 我对我正在使用/子类化/抛出异常的所有包进行了 javadoc。
5. 我将确保在概述文件中包含有关标准包和我自己的包的一些信息。

不幸的是，我现在只能解决这个问题，但我确信这可能是我的 Java 版本的问题。听起来其他人也有类似的问题，并想出了自己的解决方法。这只是我自己的=）

我仍然会回答，但同时这是最方便的选择。非常感谢！

我有这样的评论：

对于实现方法，我希望有相同的文档，但没有那些段落有id="0", using inheritdoc. 如何创作inheritdoc元素？

在此上下文中不常见的id属性使用应增加灵活性，使其不受文档中出现的段落顺序的约束。

我正在尝试使用 Stylecop 4.7.31 我有一个项目，其中声明了一个接口：

和另一个项目，其中接口的实现：

如果我使用<inheritdoc />而不是 ???，Stylecop 会忽略它并产生错误：

有什么想法我做错了吗？据谷歌称，Stylecop 大约从 4.1 版本开始支持这个标签

我希望我的 Javadoc 继承标准 JDK 类的注释。为此，我需要将 JDK 源添加到-sourcepathjavadoc 选项。为了不为 JDK 类本身生成文档，我会通过-packagenames或-subpackagesjavadoc 选项指定包，但 Javadoc Gradle 任务不支持它们。

如果我只想从父级继承所有文档，那么 phpDocumentor 中 @inheritDoc 的正确语法是什么？也许不止一种语法是正确的？

1. @inheritDoc
2. {@inheritDoc}
3. @inheritdoc
4. {@inheritdoc}

我认为文档非常模糊。PhpStorm 似乎支持所有这些，但也许我无法使用某些语法生成文档？

我最近在一台新笔记本电脑上安装了 Eclipse for PHP 并从 TYPO3.Flow 中签出包，但是每当我在 Eclipse 中使用“格式化此文件”选项时，它都会替换属性上方注释注释中 {@inheritdoc} 的每个实例/带有@ERROR 的方法！！！（包括感叹号）

我在 PHPStorm 中尝试过，但那里没有出现这种行为；{@inheritdoc} 注释被简单地忽略。

我以前从未见过这个，我在谷歌上也找不到任何关于它的信息。为什么会这样？