2012-03-28 81 views
2

在Eclipse中,當您將鼠標懸停在元素上時,只有Javadoc顯示以及元素的(無約束)簽名。在Eclipse中,如何顯示Javadocs中的泛型類型約束?

假設我有一個class X <T extends Object> {}。如果我使用Eclipse的Javadoc生成器,我會得到:

/** 
* @param <T> 
*/ 

呈現的Javadoc看起來像這樣。請注意缺少類型約束信息。

 com.domain.X<T>  Parameters:   <T>

有什麼辦法,以顯示在Eclipse的Javadoc觀衆的泛型類型的限制?

+1

爲什麼你想要在自己的聲明中記錄一些不言自明的東西? – 2012-03-28 13:54:03

+1

@edalorzo在Eclipse中,當您將鼠標懸停在元素上時,只有Javadoc顯示以及元素的(無約束)簽名。我想在Javadoc中看到它。 – 2012-03-28 13:59:47

回答

2

我輸入了一個Eclipse bug/enhancement來解決這個問題。令人難以置信的是,Markus Keller實際上在提交的3-4小時內實施/解決了這個問題!

0

該班的人體已經說T extends Object,你不需要它在javadoc中。

當記錄的東西(註釋代碼或javadoc的等),遵循這條規則:

  • 不要重複自己。如果你不遵循這個規則,那麼保持評論和代碼同步就會困難得多。
  • 不記錄什麼是明顯的。你的代碼的讀者知道這種語言。而不是解釋你做了演員,例如爲什麼你做了演員。
+0

看來這是Eclipse的Javadoc實現的一個令人生氣的限制。我同意我不應該在我的Javadoc中手動記錄它,因爲Eclipse不會將此信息添加到顯示的Javadoc中。 – 2012-03-28 14:04:06

+0

我已經適當地重寫了這個問題,所以請隨時刪除您的答案。 – 2012-03-28 14:17:56