@param
A tag @param pode arquivar um único parâmetro de um método ou construtor, ou parâmetros de tipo de uma classe de arquivo, interface e métodos genéricos. Ao usar a tag @param, devemos usar uma das tags para cada parâmetro do método. A primeira palavra em cada parágrafo será considerada um nome de parâmetro, enquanto o restante será considerado uma descrição dele:
@param max o número máximo de palavras para ler.
Ao arquivar parâmetros do tipo, devemos adicionar <e> a ambos os lados do nome do parâmetro de tipo:
@param 体中国中国中国中国
No entanto, os parâmetros de tipo geralmente não requerem documentação explícita, pois todos são muito óbvios.
@ ver
As tags @See podem criar referências cruzadas vinculadas a outros documentos Javadoc. Podemos nomear quaisquer identificadores após a tag, embora devamos qualificá -los completamente. Por exemplo, geralmente pode ser nomeado com o nome simples de um membro de uma classe, mas se o membro for um método sobrecarregado, devemos especificar a versão sobrecarregada do método, enumerando os tipos de cada parâmetro. Podemos usar um nome não qualificado para especificar a interface ou classe dentro do pacote atual, mas devemos usar um nome totalmente qualificado para especificar os tipos de outros pacotes. Podemos especificar membros do tipo usando # antes do nome do membro. Aqui estão todos válidos @ consulte os formatos de tag:
@see #getName @see Attr @see com.magic.attr.Attr @see com.magic.attr.Deck#DECK-SIZE @see com.magic.attr.Attr#getName @see com.magic.attr.Attr#Attr(String) @see com.magic.attr.Attr#Attr(String) @see com.magic.attr.Attr#Attr(String, Objeto) @see com.magic.attr @see Specificação de atributo @see "o almanaque do desenvolvedor Java"
O primeiro formulário refere -se a um método chamado GetName, localizado na mesma classe ou interface que a anotação do documento, ou em uma determinada classe circundante ou interface circundante. Essa sintaxe também pode ser aplicada a construtores e campos. O segundo formulário refere -se à classe no pacote atual ou na classe em um determinado pacote de guia. O terceiro formulário refere -se a uma classe usando um nome totalmente qualificado.
As 4 últimas formas de @see referem-se aos membros, onde os dois primeiros são sobre domínios (Deck-Siz Day and Method (GetName). Podemos usar o nome do método diretamente porque apenas um método GetName é definido na classe Att. Citações a que queremos nos referir.
O próximo formulário @see leva o leitor a um pacote específico: com.magic.attro
Os dois últimos formulários nos permitem citar outros documentos. Entre eles, o anterior usa para definir o link, e o último usa citações para incluir o nome do documento. Podemos usar os dois formulários para direcionar o leitor para outros documentos, como o manual completo.
O formulário @see (todos os formulários, exceto os dois últimos formulários acima) que nomeiam a entidade do idioma pode ser seguida por um rótulo. No documento gerado, esse nome de etiqueta substituirá o nome da entidade. Por exemplo:
@ veja #getnameattribute nomes
Um link para o documento do getName será criado, mas o texto que exibe é "nomes de atributos" em vez de "getName". Normalmente, devemos usar os nomes reais dos membros, mas os recursos mostrados aqui são ocasionalmente úteis.