有趣的Eclipse JavaDoc评论者错误

时间:2014-01-24 17:04:59

标签: java eclipse javadoc

因此,当我在我的班级实验室工作时,我使用ALT + SHIFT + J Eclipse快捷方式为我的函数自动生成Javadoc注释。以下是一些我没有问题的例子:

// ----------------------------------------------------------
 /**
 * Mutator method for setting processorSpeed.
 *
 * @param newProcessorSpeed Updated processor speed value
 */
 public void setProcessorSpeed(double newProcessorSpeed)
 {
 processorSpeed = newProcessorSpeed;
 }


 // ----------------------------------------------------------
 /**
 * Returns value of computer power
 *
 * @return numcores * processorSpeed
 */
 public double computePower()
 {
 double temp = numcores * processorSpeed;
 return temp;
 }

但是,当我尝试为此功能执行相同的快捷方式时:

public String toString()
 {
 String temp =
 processor + ", " + String.valueOf(numcores) + " cores at "
 + String.valueOf(processorSpeed) + "GHz";
 return temp;
 }

我得到的只是:

// ----------------------------------------------------------
 public String toString()
 {
 String temp =
 processor + ", " + String.valueOf(numcores) + " cores at "
 + String.valueOf(processorSpeed) + "GHz";
 return temp;
 }

只是觉得这是一个有趣的错误。很好奇是什么让Eclipse以不同的方式处理toString函数。

2 个答案:

答案 0 :(得分:2)

这不是我得到的行为。相反,我得到一个以/* (non-Javadoc)开头的块评论。这是因为toString()是一个继承的函数,这是自动文档快捷方式在我的设置中调用的行为。显然你的设置不同。

您可以通过转到窗口 - >设置您喜欢的各种上下文模板。设置然后导航到 Java - >代码风格 - >代码模板。您可以在模板中找到可以在模板中使用的变量的文档here。在我的设置中覆盖方法的注释模板是:

/* (non-Javadoc)
 * ${see_to_overridden}
 */

答案 1 :(得分:1)

因为您要覆盖该方法,所以会生成非javadoc注释。每个Java对象都继承自ObjectObject定义了toString()方法。