Java 中的内联注释：/** 与 /* 相对？

Question

我是否应该更喜欢在 java 中编写内联注释，如下所示：

/** Init operation */
mindControlLaser.engage();

而不是仅使用一个 *：

/* i'm a happy comment */

Eclipse 以不同的方式对语法进行着色，但是“工具链”（javadoc、eclipse 等）中是否真的有任何东西可以提供使用 /** */ 时我有一个优势？

Answer 1

没有理由进行内嵌评论。

/** 向 javadoc 实用程序发出信号，自动提取有关 API 的文档。在方法内部使用时它没有任何效果。

Answer 2

常规注释

/* 常规注释 */

通过常规注释，您可能会解释算法中棘手的一部分。
或者任何您不想成为 JavaDOC 一部分的内容。内联注释也是常规注释，可以在描述较短时使用。

Java 文档

/** JAVA DOC COMMENT */

使用 javadoc，您可以解释类、方法或字段（变量）。

然后，大多数 IDE（例如 Eclipse）可以在您编码时使用此信息来帮助您。
例如，如果您有一个 classA 和一个 classB，并且在 classB 中您使用了 classA 中的内容，那么如果将鼠标悬停在方法或变量上，您可以看到 JavaDOC 信息。非常方便。

此外，使用像 ant 这样的构建工具，您可以自动从 JavaDOC 构建 HTML 文件，如果您发布它们，您就可以允许其他人重用您的工作。
请在此处查找 Java 本身的文档。

Answer 3

注释的语法是/* */。

Javadoc 默认使用 /** */。这是一条注释，因为第二个 * 位于注释内，因此编译器不会有不同的看法。

因此，如果没有第二个 *，您只需添加一条注释，而使用第二个注释时，您将编写 javadoc：当将鼠标悬停在其他地方的函数调用上时，Eclipse 会识别它并给您提示等。

Answer 4

/** .... */ 将生成 Javadoc，/* ... */ 不会。

当然，它只有在正确的位置才会生成Javadoc。 Javadoc 也有一个非常明确定义的格式，请参阅此处 。

Answer 5

/** 表示“文档”注释； Javadocs 等在为代码创建文档时会查找这些内容。

因此，它们实际上应该只在方法和类之上使用，例如：

/**
 * Class to represent tigers.
 */
class Tiger {
    /**
     * Go extinct.
     */
    void goExtinct() {
    }
}

/* 变体仅表示标准注释块。

Answer 6

是的，这是使用 /** 主句的 javadoc 表示法。其他描述... */。 . 之前的第一句话将用于 javadoc 的摘要中，其余部分将用于详细视图中。

Answer 7

Javadoc 对 /** 的处理方式不同；上面有 /** 注释的类和方法将被放入 javadoc 输出中。

Answer 8

如果您使用引用格式（例如{@link ClassA}）并使用Eclipse 重命名类ClassA，如果它是javadoc 注释，它将自动更新注释。