java xml注释多行注释_/ **和/ *在Java注释中

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

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

@param ：这是用来表示什么参数被传递给一个方法，以及他们期望什么值

@return ：这是用来表示该方法将返回的结果

@throws ：这是用来表示一个方法在某些input的情况下抛出一个exception或错误

@since ：这是用来表示这个类或函数可用的最早的Java版本

作为一个例子，这里是Integer的compare方法的Javadoc：

/** * Compares two {@code int} values numerically. * The value returned is identical to what would be returned by: *

 * Integer.valueOf(x).compareTo(Integer.valueOf(y)) * 

* * @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); }

第二种forms是块(多行)注释。 如果你想在评论中有多行，你可以使用它。

我会说，你只是希望less用一些后者; 也就是说，你不想用块注释来覆盖你的代码，这些注释不能描述方法/复杂函数应该具有的行为。

由于Javadoc是对这两者的更多描述，并且可以使用它来生成实际的文档，所以对于简单的块注释，使用Javadoc将更可取。