Есть ли тег javadoc для документирования параметров универсального типа? - PullRequest
156 голосов
/ 06 января 2010

Я просматривал документацию по javadoc на сайте Sun, пытаясь найти, есть ли тег javadoc, который можно использовать для документирования сигнатуры универсального типа класса или метода.

Что-то вроде @typeparam, похожее на обычное @param, но применимо к типам, а также к методам, например,

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

Я подозреваю, что такого тега нет - я нигде не могу найти упоминания о нем, и документы API JavaSE не показывают его признаков, но это выглядит как странное упущение. Может кто-нибудь поправит меня?

Ответы [ 2 ]

222 голосов
/ 06 января 2010

Это должно быть сделано так:

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

}

Источник

27 голосов
/ 06 января 2010

Да. Просто используйте тег @param и включите угловые скобки вокруг параметра type.

Как это:

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