有趣的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对待totring的功能有所不同。

那不是我得到的行为。相反,我得到一个启动/* (non-Javadoc)的块评论。这是因为ToString()是一个继承的函数,这就是自动doc快捷方式在我的设置中调用的行为。您的设置显然是不同的。

您可以通过转到窗口 -> settings 来设置您喜欢的任何模板,然后导航到 java->代码样式 ->代码模板。您可以在模板中使用的变量的文档可以在此处找到。在我的设置中覆盖方法的注释的模板是:

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

因为您正在覆盖该方法,因此生成了非javadoc评论。每个Java对象都从Object继承,Object定义了toString()方法。

最新更新