Я просматривал документацию Javadoc на сайте Sun, пытаясь найти, существует ли тег javadoc, который может использоваться для документирования класса или универсальной подписи типа метода.
Что-то как @typeparam
, подобный обычному @param
, но применимый к типам, а также методам, например.
/**
* @typeparam T This describes my type parameter
*/
class MyClass<T> {
}
Я подозреваю, что нет такого тега - я не могу найти упоминание о нем нигде, и документы JavaSE API не показывают знака его, но это походит на нечетный пропуск. Кто-то может исправить меня?
Это должно быть сделано следующим образом:
/**
* @param <T> This describes my type parameter
*/
class MyClass<T>{
}
Да. Просто используйте тег @param и заключите угловые скобки вокруг параметра типа.
Вот так:
/**
* @param <T> This describes my type parameter
*/