bom exemplo de Javadoc [fechado]
Existe um bom exemplo de um ficheiro de código contendo Javadoc ?
Eu posso encontrar muitos bons exemplos de Javadoc na internet, eu só gostaria de descobrir a sintaxe particular usada para criá-los, e assumir que eu posso pore através da fonte de alguma biblioteca em algum lugar, mas isso parece um monte de trabalho.
11 answers
A Página Como escrever documentos para a ferramenta Javadoc contém um bom número de bons exemplos. Uma seção é chamada exemplos de comentários do Doc e contém bastantes usos.
Também, a FAQ Javadoc contém mais alguns exemplos para ilustrar as respostas.
Que tal o código-fonte JDK?
Uso um pequeno conjunto de padrões de documentação:
- sempre a documentar sobre segurança do fio
- sempre a documentar imutabilidade
- javadoc com exemplos (como formatação)
- @Depreciation with WHY and HOW to replace the annotated element
Dê uma olhada na fonte do framework de primavera, ele tem um excelente javadocs
ANT, por exemplo - código fonte navegável online: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/DefaultLogger.java?view=co
Para escolher outros ficheiros, comece por: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/?pathrev=761528
Se você estiver usando o o Eclipse, em seguida, você pode configurar o seu JDK (não JRE) em Instalado o Jre e, em seguida, usar Tipo Aberto (Ctrl + Mudança + T), dão algo como java.util.Collections
Descarregue as fontes deLucene e veja como o fazem. Eles têm bons JavaDocs.
Se instalar um JDK e escolher instalar também o código, o src.zip contém a fonte de todas as classes públicas Java. A maioria destes tem um javadoc bastante bom.
A documentação do pacote e classes do Google Guava é um bom exemplo de Javadoc. Especialmente a documentação do pacote com o arranque rápido é bem escrita.
Se toda a sua procura é a sintaxe, então isto pode ajudar: