bom exemplo de Javadoc [fechado]

140

existe um bom exemplo de um arquivo de origem que contém Javadoc ?

Posso encontrar muitos bons exemplos de Javadoc na Internet, gostaria apenas de descobrir a sintaxe específica usada para criá-los, e supor que posso vasculhar a fonte de alguma biblioteca em algum lugar, mas isso parece muito trabalho.

java javadoc

— Jason S
fonte

118

E o código-fonte do JDK, mas acessado por terceiros como o docjar? Por exemplo, a fonte de coleções .

Dessa forma, não há grande download.

— GaryF
fonte

1

Essa é uma boa resposta, já que as coleções foram escritas por Josh e Neal.

— 29429 cherouvim

Meu software antivírus diz que o link docjar não é seguro. Você conhece outros sites que apresentam a fonte das coleções? (Eu iria deixá-lo deslizar se isso não fosse uma questão bastante alto tráfego :)

— Gordon Gustafson

2

Se no Windows, a instalação do JDK contém um src.ziparquivo com o código-fonte das bibliotecas padrão.

— Sri Harsha Chilakapati

Como é legal para terceiros distribuir código protegido por direitos autorais? Ou os direitos autorais permitem isso?

— ThePyroEagle 4/16

Este é o principal problema dos links externos: "O Docjar.net está desativado para todos".

— Livro de Zeus

39

A página Como escrever comentários no documento para a ferramenta Javadoc contém um bom número de bons exemplos. Uma seção é chamada Exemplos de comentários do documento e contém vários usos.

Além disso, a FAQ do Javadoc contém mais alguns exemplos para ilustrar as respostas.

— Jared Oberhaus
fonte

Link fixo (por enquanto): oracle.com/technetwork/java/javase/documentation/…

— Jeff Evans

9

E o código fonte do JDK ?

— manteiga
fonte

esse era o meu pensamento óbvio, mas eu teria que baixar toda a grande bagunça. :-(

— Jason S

5

Provavelmente, você já o possui, já que ele vem com o JDK (embora seja uma opção de instalação).

— 227 Michael Borgwardt

5

Eu uso um pequeno conjunto de padrões de documentação:

sempre documentando sobre segurança de threads
sempre documentando imutabilidade
javadoc com exemplos (como Formatador )
@ Deprecation com WHY e HOW para substituir o elemento anotado

— dfa
fonte

grande dica para incluir como substituir a obsoleta, thx

— Tobi Tiggers

4

Dê uma olhada no código-fonte do Spring, ele possui excelentes javadocs

— Gaël Marziou
fonte

3

ANT, por exemplo, - código-fonte navegável on-line: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/DefaultLogger.java?view=co

Para escolher outros arquivos, comece em: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/?pathrev=761528

— Nick Fortescue
fonte

2

Faça o download das fontes do Lucene e veja como elas o fazem. Eles têm bons JavaDocs.

— RichieHindle
fonte

2

Se você estiver usando o Eclipse , poderá configurar seu JDK (não o JRE ) nos JREs instalados e, em seguida, usar o Tipo Aberto ( Ctrl+ Shift+ T), forneça algo comojava.util.Collections

— KrishPrabakar
fonte

1

Para adicionar ao que foi dito, a maioria dos IDEs configuram automaticamente javadocs e origem quando você configura o JDK para eles usarem. Isso não se aplica apenas ao Eclipse.

— ThePyroEagle 4/16

2

A documentação do pacote e das classes EventBus do Google Guava é um bom exemplo de Javadoc. Especialmente a documentação do pacote com o início rápido está bem escrita.

— Marvin Frommhold
fonte

1

Se você instalar um JDK e optar por instalar fontes também, o src.zip conterá a fonte de TODAS as classes Java públicas. A maioria destes possui javadoc muito bom.

— Thorbjørn Ravn Andersen
fonte

1

Se tudo o que você procura é a sintaxe, isso pode ajudar:

Como escrever comentários do documento para a ferramenta Javadoc

— Jesse
fonte

1

obrigado, já ciente de que, embora (ver a minha pergunta)

— Jason S

Resposta duplicada sem fornecer outras informações úteis.

— Alexey Ivanov