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