Java: Criando Nova Anotações

Você viu comentários usados ​​em muitos exemplos de código Java. O compilador ignora comentários, por isso, quando você cria um comentário, você pode escrever qualquer coisa que você sente será útil mais tarde para descobrir o que o aplicativo pode fazer. Comentários documentar seu código.

No entanto, há um outro tipo de documentação - a anotação. Uma anotação é um tipo de documentação que o compilador também entende. Quando o compilador vê anotação em seu código, ele sabe que ele precisa fazer algo especial com o código que se segue. Anotações são úteis para documentar o seu código de uma forma funcional para que o compilador pode ajudar a reforçar o que a documentação que você fornecer.

O conjunto de anotações predefinidas que vêm com Java são relativamente limitadas em uso. Para criar anotações realmente úteis, você tem que projetar-los ou levá-los como parte de um pacote de terceiros. Criando uma nova anotação é um processo de três etapas:

  1. Adicionar a instrução de importação apropriado:

    importar java.lang.annotation. * -
  2. Definir uma interface que descreve a anotação para o compilador:

    . // Criar uma descrição anotação @ documentada interface de @ AuthorData {Nome String () - corda Date () - Versão double () padrão 1.0-}

    Neste caso, a anotação aparece na documentação criado por Javadoc porque inclui a anotação @Documented. Cada anotação descrição inicia-se com a palavra-chave @interface seguido pelo nome do tipo de anotação, o qual é AuthorData neste caso.

    Dentro das chaves, você vê os campos usados ​​para definir os dados de anotação. Este exemplo inclui Nome, Data e Versão. A palavra-chave padrão fornece um valor para um campo particular. Isso significa que o campo irá usar o valor se não for definido como parte da anotação na aplicação.

  3. Use a anotação na aplicação:

    @AuthorData (Name = "John Smythe", Data = "2014/04/01")

    A anotação aparece antes do elemento que afeta, como uma declaração de classe. Você deve definir cada campo que não tem um valor padrão. Opcionalmente, você também definir campos que têm um valor padrão. Neste caso, o nome do autor é John Smythe, eo código foi atualizado em 2014/04/01 passado.

menu