是否有用於記錄泛型類型參數的javadoc標籤？

129

我一直在瀏覽Sun網站上的javadoc文檔，試圖找出是否有一個javadoc標籤可用於記錄類或方法的泛型類型簽名。是否有用於記錄泛型類型參數的javadoc標籤？

類似於@typeparam，類似於通常的@param，但適用於類型以及方法，

/** 
* @typeparam T This describes my type parameter 
*/ 
class MyClass<T> { 
}

我懷疑有沒有這樣的標籤 - 我可以在任何地方找到沒有提到它，和JavaSE的API文檔不顯示它的任何跡象，但它似乎是一個奇怪的遺漏。有人能幫我解決嗎？

2010-01-06 skaffman

要寫出正確的javadoc？ – 2010-01-06 20:33:13

請注意，對於* most *類，實際上沒有什麼有趣的關於類型參數的說法，因爲類型參數基本上是通過它在對象的方法中的表現來定義的。大多數情況下，我會跳過'@param '，並且只在真的不清楚時才使用它。 – 2010-01-06 21:06:19

我明白你在說什麼，但是按照這個理由，對於方法參數使用'@param'也是一樣的。 Sun的編碼標準明確指出，即使方法參數的含義清晰，也應該使用@param。 – skaffman 2010-01-06 21:11:34

178

它應該做的事就像這樣：

/** 
* @param <T> This describes my type parameter 
*/ 
class MyClass<T>{ 

}

2010-01-06 20:30:59

Doh ....好的，這很明顯......它確實討論了爲什麼JavaSE類（例如'Collection'）不使用它的問題。 – skaffman 2010-01-06 20:34:08

奇怪的是，它沒有在標準文檔中記錄。 – 2010-01-06 20:34:32

LinkedList使用它：http://java.sun.com/j2se/1.5.0/docs/api/java/util/LinkedList.html – 2010-01-06 20:41:38

是。只需使用@param標記，並在類型參數周圍包含尖括號。

像這樣：

/** 
* @param <T> This describes my type parameter 
*/

2010-01-06 20:32:01

回答