Eu estive examinando a documentação do javadoc no site da Sun, tentando descobrir se há uma tag javadoc que pode ser usada para documentar uma assinatura de tipo genérica de classe ou método.
Algo @typeparam
parecido com o habitual @param
, mas aplicável a tipos e métodos, por exemplo
/**
* @typeparam T This describes my type parameter
*/
class MyClass<T> {
}
Suspeito que não exista essa tag - não consigo mencioná-la em nenhum lugar, e os documentos da API do JavaSE não mostram nenhum sinal, mas parece uma omissão estranha. Alguém pode me colocar certo?
@param <T>
maior parte do tempo e só a usaria quando realmente não estivesse claro.@param
para parâmetros de método. Os padrões de codificação da Sun dizem explicitamente que@param
devem ser usados mesmo que o significado do parâmetro do método seja claro.Respostas:
Isso deve ser feito assim:
Fonte
fonte
Collection
) não a usam.Sim. Basta usar a tag @param e incluir colchetes angulares ao redor do parâmetro type.
Como isso:
fonte