bom exemplo de Javadoc [fechado]
https://stackoverflow.com/questions/1079713
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianPergunta
Existe um bom exemplo de um arquivo de origem contendo Javadoc ?
posso encontrar muitos bons exemplos de Javadoc na internet, eu gostaria apenas de descobrir a sintaxe particular usado para criá-los e assumir posso poros através da fonte de algum lugar biblioteca mas que parece ser um monte de trabalho.
Solução
Como sobre o código fonte JDK, mas acessado através de um terceiro partido como docjar? Por exemplo, o fonte coleções .
Dessa forma, não há nenhuma grande download.
Outras dicas
A página Como escrever Doc Coments para a ferramenta Javadoc contém um bom número de bons exemplos. Uma seção é chamado href="http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#examples" Exemplos de Doc Comentários e contém muito poucos usos.
Além disso, o Javadoc FAQ contém um pouco mais exemplos para ilustrar as respostas.
Como sobre o JDK código fonte?
Eu uso um pequeno conjunto de padrões de documentação:
- sempre documentar sobre thread-segurança
- sempre documentar imutabilidade
- javadoc com exemplos (como Formatter )
- @Deprecation com o porquê e como substituir o elemento anotado
Tenha um olhar na fonte framework Spring, tem excelentes javadocs
ANT por exemplo - navegável código fonte on-line: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/DefaultLogger.java?view=co
Para escolher outros arquivos começam a partir de: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/?pathrev=761528
Faça o download das fontes de Lucene e ver como eles fazem isso. Eles têm bons JavaDocs.
Se você estiver usando Eclipse , então você pode configurar o JDK (não JRE ) em JREs Instalados e use Open Type ( Ctrl + Mudança + T ), give algo como java.util.Collections
A documentação do Google Guava pacote e aulas EventBus é um bom exemplo de Javadoc. Especialmente a documentação do pacote com o início rápido é bem escrito.
Se você instalar um JDK e optar por instalar fontes também, a src.zip contém a fonte de todas as classes Java públicas. A maioria destes tem muito bom javadoc.
Se tudo você está procurando é a sintaxe, então isso pode ajudar:
Como escrever Doc Comentários para o Javadoc Ferramenta
