it-swarm-pt.tech

Como você lê o JavaDoc?

Quais ferramentas/sites você usa para ler JavaDocs?

Atualmente, uso o Firefox com mais de 20 guias abertas ao trabalhar em um projeto J2EE para ter toda a documentação disponível que não é muito utilizável, está consumindo muita memória e não é pesquisável.

O que eu esperaria de tal ferramenta/site:

  • Agregue JavaDocs de diferentes locais
  • Acesso direto a tipos como Ctrl + T no Eclipse ou similar
  • Pesquisa de texto completo
  • Referência cruzada entre todas as bibliotecas Java que eu escolhi
  • Para uma ferramenta: suporte offline
  • Rapidez

não obrigatório:

  • possibilidade de anotar coisas
  • suporte para diferentes versões de uma biblioteca (+ diferente?)
  • Integração IDE

Editar:

Obrigado por suas respostas. Eu conhecia a maioria dos sites, mas tentei novamente. Aqui está o meu julgamento:

  • recursos internos do Eclipse/IDE
    • firmemente integrado
    • suporte offline/online
  • javadoconline.com (não é mais mantida)
    • trabalho
    • aparência limpa
    • localiza correspondências em mais de uma versão da API e permite alternar facilmente
    • simples, mas trabalhando
    • velozes
  • jdocs (offline)
    • parece muito sofisticado
    • às vezes lento
    • algumas versões recentes das bibliotecas parecem estar ausentes (Seam 2.0.0, Hibernate Validators), mas parece que você pode adicioná-las
    • Integração IDE (não testada)
    • comentários no estilo wiki para cada item
  • docjar.com
    • trabalho
    • velozes
    • uI desorganizada
  • javadoc_isearch
    • script greasemonkey para o firefox, que facilita a navegação nos javadocs
    • funciona suave e perfeitamente
30
jrudolph

Se você usa o Eclipse, ele oferece suporte para Javadocs. Por exemplo, passar o mouse sobre uma chamada de método exibirá uma dica de ferramenta mostrando o Javadoc para esse método. Documentação para o core Java são suportadas prontamente. No entanto, se o seu projeto usa bibliotecas adicionais (arquivos JAR)), alguma configuração é necessária para conectar seus Javadocs ao Eclipse.

  1. Vá para a seção "Java Build Path" das propriedades do seu projeto.
  2. Vá para a guia "Bibliotecas" e clique no ícone "mais" ao lado do arquivo JAR.
  3. Clique em "Javadoc location" e depois no botão "Edit ...".

Isso permitirá que você especifique onde os Javadocs desse JAR estão localizados. Ele permitirá que você especifique o URL de um site, para que você não precise baixar os Javadocs por conta própria!

9
Michael

Eu escrevi minha própria ferramenta para isso. Segundo meus colegas, é melhor que eles vejam.

Ele indexa por lucene uma vez e executa seu pequeno servidor em segundo plano, para que você navegue em javadocs (pydocs, perldocs ..) como no navegador. Ele também permite bibliotecas separadas por idioma para que pesquisas como "biginteger" ou simialr não dêem errado.

https://github.com/judovana/JavadocOfflineSearch/releases

2
judovana

Você pode encontrar o JavaDoc da Universidade de Stanford aqui .

2
Léo Léopold Hertz 준영

O jar JavaDoc pode ser descompactado diretamente. Em teoria, qualquer javadocs lançado pode ser baixado e visualizado offline.

  1. faça o download diretamente do repositório maven. Por exemplo: http://central.maven.org/maven2/com/googlecode/objectify/objectify/5.0.3/objectify-5.0.3-javadoc.jar

  2. Agora você tem objectify-5.0.3-javadoc.jar, renomeie o arquivo para objectify-5.0.3-javadoc.Zip

  3. use sua ferramenta de descompactação favorita para extraí-la, agora você tem uma pasta objectify-5.0.3-javadoc

  4. duplo click index.html abrirá a página de índice no seu navegador padrão.

2
Max

Eu uso http://www.teria.com/~koseki/tools/gm/javadoc_isearch/ para FF. Permite que eu navegue facilmente em outras bibliotecas também.

2
Swati

Este plug-in para o Firefox e Chrome é útil para encontrar rapidamente nomes de pacotes e classes, embora não seja uma pesquisa de texto completo: https://code.google.com/p/ javadoc-search-frame /

1
Glenn Lawrence

O Eclipse se integra bem ao Javadoc e possui um visualizador semelhante ao HTML. Você pode anexar fonte e javadoc a binários que aparecerão quando você selecionar uma classe.

1
Heath Borders

Algo assim pode ser útil?

http://www.docjar.com/

1
user7094

Pessoalmente, nunca tive problemas com as ferramentas internas de navegação javadoc oferecidas pelo meu IDE.

Atualmente, eu uso o IntelliJ Idea - o Ctl-Q exibe o javadoc para o método sob o cursor, com os hiperlinks para outras partes da documentação funcionais.

Eu imagino que o NetBeans e o Eclipse ofereçam funcionalidades semelhantes.

1
Rob Dickerson

Hum ... Que tal:

  • http://edu.netbeans.org/quicktour/javadoc.html - O NetBeans suporta o padrão Javadoc para Java - exibindo-o e gerando-o).
  • http://globaldocs.zeevbelkin.com/ - Este aplicativo permite navegar comodamente, pela Internet e pelo sistema de arquivos local, vários conjuntos javadoc, usando uma única árvore de hierarquia de pacotes/classes e um índice pesquisável. O visualizador suporta documentos locais e remotos (os documentos locais, compactados em arquivos JAR/Zip também são suportados).

Prefiro o NetBeans como ele obtém JavaDoc de Maven ~/.m2 diretório automaticamente ...

1
gavenkoa

Doxigênio ( http://www.doxygen.nl/ ) pode caber na conta.

EDIT: Posso ter interpretado mal sua pergunta, doxygen é uma ferramenta para gerar documentação e modelos com base no seu código e javadoc.

0
mmattax

O Eclipse é a melhor maneira de ver os javadocs. Passando o mouse sobre o método ou qualquer declaração, você obterá javadocs gerados automaticamente pelo Eclipse.

0
Rohit deol