java - javadoc“@author”没有显示？

Question

每当我在 intelliJ 中输入 "Printing" 并按 CTRL Q 时，我只能看到 "Summary" 而看不到 "Bob" 。. . 我究竟做错了什么？

package printing;
 /**
 * @author Bob
 * <b>Summary</b>
 */
public class Printer {
//stuff
}

***注意：我只是在学习如何使用“javadoc”，所以我希望能得到解释。

编辑：除非我取出“@author”，否则我什至看不到“摘要”

Answer 1

听起来像是 IntelliJ 的问题/功能。Eclipse 显示整个 javadoc，包括@author. 其他可能的问题是出现<b>Summary</b>右后@author。

因此，尝试删除摘要，看看会发生什么。也尝试真正生成 javadoc，例如从命令行运行javadoc实用程序，看看会发生什么。我确信在这种情况下Bob会出现。祝你好运。

Answer 2

我可以重现这种行为并提出了一个问题来跟踪它：http: //youtrack.jetbrains.com/issue/IDEA-114499

这是我使用的一段代码：

package printing;

/**
 * @author Simba
 * @version 1
 * @see java.util.Arrays
 * @since 1
 */
public class Printer {
}

以及由此产生的文档：

---

但是，如果您尝试Tools -> Generate JavaDoc使用以下设置生成 javadoc：

然后，生成的 javadoc 确实显示了作者标签：

因此证明 javadoc 本身是健全的，并且是 IntelliJ 不显示它。

Answer 3

当javadoc从控制台使用时，您可以像这样将-authorand-version选项添加到调用中（-d设置输出目录）：

javadoc src/main/java/com/*.java -d src/docs/javadocs/ -author -version

使用这些设置显示作者和版本。

---

javadoc帮助（只需键入javadoc）显示以下内容 - 正如AlexR已经提到的 - （缩短）：

...
Provided by Standard doclet:
  -d <directory>                   Destination directory for output files
  -use                             Create class and package usage pages
  -version                         Include @version paragraphs
  -author                          Include @author paragraphs
...

Answer 4

如果你在命令行中这样做，你可以使用这个：

javadoc -d javadoc -author -version  YourClass.java

将 .java 的名称更改为您的类名。如果要显示作者标签，​​则必须添加 -author 并且与版本相同 -version

请记住，-d 参数用于定义文件夹并取决于您的实际路径，因此如果您位于 C:\Users\joselito 您的 javadoc 文件夹必须位于 C:\Users\joselito\javadoc

Answer 5

当您单击生成 Javadoc 时，您会发现一些选项。

1. 转到输出目录下方。
2. 勾选作者选项。

// 这是为 intellij Idea 准备的。