Boas Práticas de Documentação Java (Javadoc)

• Membros públicos e protegidos devem ser documentados com comentários Javadoc.
• É recomendado documentar também membros package-private e privados, especialmente se forem complexos ou não autoexplicativos.
• A primeira frase do comentário Javadoc é a descrição resumida. Deve ser uma visão geral concisa do que o método faz e terminar com um ponto.
• Use @param para parâmetros de métodos. A descrição começa com letra minúscula e não termina com ponto.
• Use @return para valores de retorno de métodos.
• Use @throws ou @exception para documentar exceções lançadas por métodos.
• Use @see para referências a outros tipos ou membros.
• Use {@inheritDoc} para herdar documentação de classes base ou interfaces.
  • A menos que haja uma grande mudança de comportamento, caso em que você deve documentar as diferenças.
• Use @param <T> para parâmetros de tipo em tipos ou métodos genéricos.
• Use {@code} para trechos de código inline.
• Use <pre>{@code ... }</pre> para blocos de código.
• Use @since para indicar quando o recurso foi introduzido (por exemplo, número da versão).
• Use @version para especificar a versão do membro.
• Use @author para especificar o autor do código.
• Use @deprecated para marcar um membro como obsoleto e fornecer uma alternativa.