Интересная ошибка комментатора JavaDoc Eclipse

Question

Итак, когда я работал над лабораторией для своего класса, я использовал ярлык 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 по-разному.

Answer 1

Поскольку вы переписываете метод, генерируется комментарий, отличный от javadoc. Каждый объект Java наследует от Object и Object определяет метод toString().

Answer 2

Это не то поведение, которое я получаю. Вместо этого я получаю комментарий блока, который начинается /* (non-Javadoc). Это связано с тем, что toString() является унаследованной функцией, и это поведение, вызываемое ярлыком auto-doc в моей настройке. Очевидно, что вы настроены по-другому.

Вы можете установить любой понравившийся шаблон для различных контекстов, перейдя в Window -> Настройки, а затем перейдите на Java -> Code Style -> Code Templates. Документы для переменных, которые можно использовать в шаблоне, можно найти here. Шаблон для комментариев к переопределяющим методам в моей настройке:

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