/**Java注释中的和/*

Question

两者之间有什么区别

/**
 * comment
 *
 *
 */

和

/*
 * 
 * comment
 *
 */

在Java？我应该什么时候使用它们？

Answer 1

首先是Javadoc注释。它们可以由javadoc工具处理，为您的类生成API留档。第二种是正常的块评论。

Answer 2

对于Java的编程语言来说，两者没有区别，Java有两种类型的注释：传统注释（/*...*/）和行尾注释（/... ）。请参阅Java语言规范。因此，对于Java编程语言，/*...*/和/*...*/都是传统注释的实例，它们都被Java编译器，即它们被忽略（或者更正确地说：它们被视为空白）。

但是，作为Java程序员，您不仅使用Java编译器。您使用一个完整的工具链，包括编译器、IDE、构建系统等，其中一些工具的解释与Java编译器不同。特别是，/***/ 注释由Javadoc工具解释，该工具包含在Java平台中并生成文档。Javadoc工具将扫描Java源文件并解释/***/ 作为文档。

这类似于像FIXME和TODO这样的标签：如果您包含像//TODO： fix this或//FIXME： do that这样的注释，大多数IDE将突出显示这样的注释，以便您不要忘记他们。但对Java来说，它们只是评论。

Answer 3

第一种形式叫做Javadoc。当您为代码编写正式的API时，可以使用它，这些API是由javadoc工具生成的。例如，Java7 API页面使用Javadoc并由该工具生成。

在Javadoc中可以看到的一些常见元素包括：

>

@参数：这用于指示传递给方法的参数，以及它们应该具有的值

@return：用于指示方法将返回的结果

@throws：用于指示方法在某些输入情况下引发异常或错误

@自：用于指示该类或函数在中可用的最早Java版本

举个例子，下面是用于Integer的compare方法的Javadoc：

/**
 * Compares two {@code int} values numerically.
 * The value returned is identical to what would be returned by:
 * <pre>
 *    Integer.valueOf(x).compareTo(Integer.valueOf(y))
 * </pre>
 *
 * @param  x the first {@code int} to compare
 * @param  y the second {@code int} to compare
 * @return the value {@code 0} if {@code x == y};
 *         a value less than {@code 0} if {@code x < y}; and
 *         a value greater than {@code 0} if {@code x > y}
 * @since 1.7
 */
public static int compare(int x, int y) {
    return (x < y) ? -1 : ((x == y) ? 0 : 1);
}

第二种形式是块（多行）注释。如果希望注释中有多行，可以使用此选项。

我会说，你只想少用后一种形式；也就是说，您不希望代码中出现无法描述方法/复杂函数应该具有的行为的块注释，从而使代码负担过重。

由于Javadoc更具描述性，使用它可以生成实际的文档，因此使用Javadoc比使用简单的块注释更可取。