Instalando Javadocs do Hibernate 3 no Netbeans

quarta-feira, 13 de janeiro de 2010 Postado por Luis Fernando

*** Pode ter certeza, você NÃO vai achar uma dica dessas facilmente por aí!!! ***

A documentação do Hibernate é riquíssima e muito consistente, mas é ridículo ser obrigado a parar bruscamente o seu trabalho para recorrer ao website/pdf/chm, ou seja lá qual o meio de acesso que você usa para buscar informações ou tirar dúvidas, muitas vezes simples, na vasta documentação deste poderoso framework.

Eu já cheguei a desistir de entender melhor as características de um determinado método depois de me perder nos milhares de tópicos.

Esse processo trabalhoso se torna ainda mais desnecessário quando usamos uma ferramenta de rápido desenvolvimento, as famosas IDEs, como por exemplo o Netbeans. Isso porque elas nos dão a possibilidade de acessar a documentação de qualquer biblioteca ou projeto diretamente no código, sem a necessidade de quebrar a linha de raciocínio só para descobrir quais são as sobrecargas (overload) para um determinado método. É fácil perceber isso quando usamos objetos da API do próprio Java, um exemplo seria o String.

Aqui vai uma print screen com o javadoc do Hibernate já funcionando;

image

Resolvi fazer este tutorial quando percebi que não é fácil encontrar a documentação mais nova e muitos fóruns tem tópicos e tópicos com dúvidas sobre isso.

Bom, chega de enrolação, vamos ao que interessa.

Ferramentas usadas neste tutorial;

  • * Netbeans 6.8
  • * Hibernate-distribution-3.3.2.GA

Para fazer uso da documentação diretamente no código você precisa associar sua biblioteca (library) ou projeto a um arquivo Javadoc (.jar contendo toda a documentação) específico daquela biblioteca ou projeto.

Deste a versão 3.2.6 o Hibernate não vem com seu Javadoc (não me pergunte porque) e muitos fazem uso da documentação antiga, já seria de grande ajuda e claro que quebra o galho, mas eu não fiquei satisfeito e tratei de procurar pela versão mais nova.

Ela se encontra aqui ==>

hibernate-core-3.3.2.GA-javadoc.jar

Se quiser, aproveite também pra pegar o código fonte aqui ==>

hibernate-core-3.3.2.GA-sources.jar

Crie um projeto no Netbeans e adicione as bibliotecas do Hibernate como de costume.

  • Agora clique com o botão direito sobre o Projeto
  • Selecione a opção Propriedades (Properties)
  • Clique em Bibliotecas (Libraries).

Muita atenção nessa parte...

  • Clique sobre a biblioteca com a qual você quer adicionar o javadoc
  • No caso do Hibernate 3.3.2 é a hibernate3.jar
  • Do lado direito dessa mesma tela tem a opção Editar (Edit), clique nela
  • Agora ficou fácil, né? é só clicar em Procurar (Search)
  • Selecione o arquivo hibernate-core-3.3.2.GA-javadoc.jar
  • Marque OK em todas as telas e pronto!

É só isso! Seu projeto já está pronto, faça os testes.

Se tiver qualquer dúvida comente aqui que eu respondo o mais rápido possível.

Obrigado pela visita e boa sorte!!!

Marcadores: ,
  1. Anônimo
  2. Anônimo

    Olha, do fundo do meu coração, mt obrigado.
    Você não faz idéia o quanto eu precisei disso e não encontrava, e nem era para o hibernate.

  3. Apenas observando que o link está quebrado: um link que está funcionando em 29/06/2011 está em http://www.findjar.com/jar/org.hibernate/javadoc/hibernate-3.2.2.ga-javadoc.jar.html

  4. Um método simples
    Menu Ferramentas, Plataformas java, aba Javadoc,
    Adicionar URL
    http://docs.jboss.org/hibernate/orm/3.5/api/

Postar um comentário