Javadoc 不生成作者答案

【问题标题】：Javadoc not generating authorJavadoc 不生成作者
【发布时间】：2014-02-25 15:23:40
【问题描述】：

我正在尝试为程序生成 javadoc，但是整个第一个块不包含在文档中。我有两个类文件，Item.java 和 Proj1.java，但都不会包含第一个注释块。在 Item.java 中，它看起来像这样：

/************************************************************************
 * @author Namfuak
 * @version 1.0, Spring 2014
 * Class file of an Item to use in proj1.
 * Contains the name and price
 * of the item, as well as a few helpful methods.
 ************************************************************************/

import java.text.DecimalFormat;

/**
  Contains data for each Item to be tallied.  Item name and price are
  stored in private variables.
 */

奇怪的是，虽然第二个块（“包含数据...”）也在类范围之外，但它包含在文档中。我尝试将标题块重新格式化为没有额外的星号，没有星号开头的行，并且在 import 语句之后，但行为没有改变。我在命令行语句中包含且未包含“-author”和“-version”标签，没有任何更改。 javadoc 命令行输出没有说有任何警告或错误。

【问题讨论】：

标签： java javadoc

【解决方案1】：

因为 javadoc 编译器无法识别。

http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#principles

具体来说：

第一行包含开始注释分隔符 (/**)。
最后一行包含结束注释分隔符 (*/) 请注意，与开始注释分隔符不同，结束注释只包含一个星号。

这就是第二位是变成Javadoc的原因。

从 cmets 编辑： 类的顶部不能有两个块；只有一个会被使用。此外，规范指出导入之前的 cmets 将被忽略。

http://docs.oracle.com/javase/7/docs/technotes/tools/solaris/javadoc.html#documentationcomments

cmets 的放置 - 文档 cmets 仅在紧接在类、接口、构造函数、方法或字段声明之前被识别 - 请参阅类示例、方法示例和字段示例。放置在方法主体中的文档 cmets 将被忽略。 Javadoc 工具只能识别每个声明语句的一个文档注释。

一个常见的错误是在类注释和类声明之间放置一个 import 语句。避免这种情况，因为 Javadoc 工具会忽略类注释。

该类应如下所示：

import java.text.DecimalFormat;
/**
 * Contains data for each Item to be tallied.  Item name and price are
 * stored in private variables.
 * @author Namfuak
 * @version 1.0, Spring 2014
 */
 public class MyClass {

【讨论】：

正如我所提到的，我已经尝试过与第二个块完全相同的格式，没有行为改变。
但不要只使用 /************* /**
OP 是正确的。这不仅仅是不正确的 JavaDoc cmets 格式。 stackoverflow.com/questions/19186239/javadoc-author-not-showing
好的，我已经开始工作了，谢谢。 @peter.petrov，我在发布这个问题之前看到了这个问题，这显然是 Intelj 的问题，我没有使用它。如果这是 Javadocs 本身的问题，那么我想那是令人放心的。
是的。此外，如果您想要版本，则必须在命令开头添加 -version

【解决方案2】：

添加

@author Namfuak
@version 1.0, Spring 2014

在第二个评论区。

它应该在那里，在 cmets 块中
就在您的课程代码开始之前。

详情请看这里。

JavaDoc

另外，在调用 JavaDoc 工具时使用 -author。

【讨论】：