Gestão de Identificadores Javadoc @since

As Ferramentas da API fornecem suporte para a gestão de identificadores @since de Javadoc em novos elementos que foram adicionados à API (tipos, métodos, campos, etc). Os novos elementos da API devem ser um novo tipo adicionado a um pacote da API, um novo tipo adicionado a um tipo de API, um novo método adicionado a um tipo de API ou um novo campo adicionado a um tipo de API. A adição do método é um caso especial, em que a adição do método pode ser adicionar um método a um tipo, substituir um método de classe ascendente, implementar um método da interface ascendente ou alterar uma assinatura de métodos existentes.

Nota: As informações de identificador @since não são propagadas através da implementação ou subclasses. Cada elemento adicionado à API espera-se que tenha o seu próprio identificador @since e informações da versão.

As ferramentas facultam a validação seguinte para identificadores@since:

As preferências da gestão do identificador @since podem alterar-se na página de preferências Abre a página de preferências da Consola Desenvolvimento de Plug-in> Erros/Avisos da API.

Identificadores @since em falta

Cada novo elemento da API detectado será verificado através das ferramentas para assegurar que tem um identificador @since. Se o novo elemento não tiver um identificador @since, ficará sinalizado como um que necessita, e será proposta uma versão para o identificador. A versão proposta para o novo identificador será a versão actual do lote - excepto no caso de uma novidade de alteração da API, em que a versão do lote também necessite de actualização. Se a versão do lote também precisar de actualização, a versão proposta para o identificador @since em falta será o da versão de lote proposta.

Considere o exemplo seguinte: temos um lote A com a versão 1.0.0 e temos uma classe C que foi adicionada na versão 1.1.0 de A que contém o método m1().

Identificadores @since incorrectos

Novos elementos podem ter os respectivos identificadores @since verificados para consistência para assegurar que estão devidamente formulados. As ferramentas da API verificam que todos os identificadores @since seguem o formato geral de:

[@since] [pre-amble] [2 part version] [post-amble]

Considere os seguintes exemplos de identificadores @since:

Versões de identificadores @since não válidos

Novos elementos também podem ter os identificadores @since verificados relativamente à validade. É considerado válido um identificador@since se as informações da versão no identificador corresponderem à versão do lote.

Considere o exemplo seguinte onde adicionámos um novo método m2() a uma classe da API no lote A cuja versão é 1.0.0:

Tarefas relacionadas
Configurar uma linha de base

Referência relacionada
Preferências de Linhas de Base de API
Preferências de Erros e Avisos de API