2014-01-24 61 views
0

因此,當我在爲我的課程開發實驗室時,我使用了ALT + SHIFT + J Eclipse快捷方式爲我的函數自動生成Javadoc註釋。下面是一些例子,我有沒有問題:有趣的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函數感到好奇的。

回答

1

因爲您正在覆蓋該方法,所以會生成非javadoc註釋。每個Java對象都繼承自Object,而Object定義了一個toString()方法。

2

這不是我得到的行爲。相反,我得到一個塊註釋,開始/* (non-Javadoc)。這是因爲toString()是一個繼承函數,這就是auto-doc快捷方式在我的設置中調用的行爲。你的設置明顯不同。

您可以將窗口中設置你喜歡的各種情況下的任何模板 - >設置,然後導航至爪哇 - >代碼樣式 - >代碼模板。您可以在模板中使用的變量的文檔可以找到here。在我的設置中覆蓋方法的註釋模板是:

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