Trabalho de (LP2A4) - LINGUAGEM DE PROGRAMAÇÃO II

1. Javadoc
Escrita de documentação Java e geração de
documentação publicável com javadoc
Maik & Ricardo

2. Apresentação
- O que é documentação de software?
- O que é Javadoc?
- Exemplo de marcações
- Como executar o javadoc
- Exemplo no código
Referência 2 (imagem)

3. O que é documentação de software?
A documentação de software ou documentação do código fonte, é um
texto escrito que acompanha o software e geralmente explica como
utilizá-lo.
A documentação de software pode auxiliar usuários e programadores
sobre as rotinas que estão contidas no software facilitando o uso e o
desenvolvimento para futuras evoluções.
Referência 1

4. O que é Javadoc?
Javadoc é um gerador de documentação criado pela Sun Microsystems
para documentar programas em Java, a partir do código-fonte sendo
gerado pelo Doclet. O resultado é em HTML. É constituído, basicamente,
por algumas marcações (tags) muitos simples inseridas nos comentários
do programa.
Referência 3

5. Exemplo de marcações
Referência 3 e 5
@author Nome do autor
@deprecated Método obsoleto
@exception Exceção lançada por um método
@param Parâmetro(s) dentro do método
@return Retorno do método
@see Associação a outro método ou classe.
@since Data de quando o método foi adicionado a classe.
@throws Exceção lançada por um método
@version Versão da classe ou método.

6. Como executar o javadoc
Referência 4
$ javadoc NomeClasse.java
$ javadoc -d NomeDiretorio NomeClasse.java
$ javadoc {packages|source-files} [options] [@argfiles]
$ javadoc -private -d NomeDiretorio *.java
"C:Arquivos de programasJavajdk1.6.0binjavadoc" -d doc *.java

7. Exemplos no código

13. Referências
1. https://pt.wikipedia.org/wiki/Documenta%C3%A7%C3%A3o_de_software
2. https://numenta.org/blog/2014/12/03/htm-on-the-jvm/
3. https://pt.wikipedia.org/wiki/Javadoc
4. https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.htm
5. https://www.devmedia.com.br/entendendo-anotacoes-em-java/26772
6. https://www.tutorialspoint.com/java/java_documentation.htm (Tabela com mais tags)