有什么区别
/**
* comment
*
*
*/
and
/*
*
* comment
*
*/
在Java中？我什么时候应该使用它们？
第一种形式称为Javadoc http://en.wikipedia.org/wiki/Javadoc。当您为代码编写正式的 API 时，可以使用它，这些 API 由javadoc工具。举个例子，Java 7 API 页面 http://docs.oracle.com/javase/7/docs/api/使用 Javadoc 并由该工具生成。
您在 Javadoc 中看到的一些常见元素包括：
@param：这用于指示哪些参数被传递给方法，以及它们期望具有什么值
@return：这用于指示该方法将返回什么结果
@throws：这用于指示方法在某些输入的情况下抛出异常或错误
@since：这用于指示该类或函数可用的最早的 Java 版本
作为示例，这里是 Javadoccompare的方法Integer:
/**
* 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 比简单的块注释更可取。
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)
