/ **评论。 * / VS / * comment * / in Java

时间:2015-07-19 22:09:42

标签: java

每当我需要记笔记或解释函数时,我总是在Java中使用comment运算符。

/*
 * Comment
 */

我也看到有人像这样使用评论运算符

/**
 * Comment.
 */

有趣的是,如果您使用此注释运算符,如果您有参数,它将显示@param;如果您有返回,它将显示@return。

他告诉我,我需要在句子末尾加上句号;那么,如果您在其他地方使用该功能,您可以将注释视为文档,例如Javadoc。

我不知道如何将评论视为文档。你能告诉我如何在Netbean和Eclipse中显示它。谢谢!

2 个答案:

答案 0 :(得分:1)

你的同事是对的:这是Javadoc的评论。您可以直接使用Javadoc工具将其转换为HTML(然后可以使用浏览器打开),或者让IDE为您执行此操作:

答案 1 :(得分:0)

是的,这用于记录功能或类。

/**
* This function is used to add integer a to integer b.
*
* @param this first integer.
* @param b the second integer
* @return the addition of a and b
*/
public int add(int a, int b) {
    return a + b;
}

如果你的代码中的其他地方你调用此功能,你将能够看到评论。 (编辑器自动完成的事件)。