30.06.2013 Views

Apostila Java

Apostila Java

Apostila Java

SHOW MORE
SHOW LESS

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

ABSTRAÇÃO DE DADOS<br />

}<br />

public void toString ()<br />

{<br />

System.out.println("Objeto atual = " + this);<br />

}<br />

//... demais métodos ...<br />

Gerando a documentação de um programa - javadoc<br />

Dentre os programas que compõem o ambiente de desenvolvimento <strong>Java</strong>, um dos mais interessantes é<br />

o gerador automático de documentação, o javadoc. <strong>Java</strong>doc é um aplicativo que gera arquivos Html a<br />

partir de um ou mais códigos fonte <strong>Java</strong>. Essa documentação é útil para que outros desenvolvedores<br />

consultem a funcionalidade das classes implementadas por terceiros.<br />

Por exemplo: suponha que você tenha implementado as classes de um sistema de avaliação de alunos<br />

da FIC. E suponha que um outro programador deve usar essas classes para gerar uma interface gráfica<br />

que permita que os professores da faculdade atualizem as notas dos alunos via Internet. Esse outro<br />

programador deverá ser informado sobre a funcionalidade das classes implementadas por você, ou seja,<br />

qual a classe que representa uma avaliação, um aluno, etc. e quais os métodos dessas classes devem<br />

ser usados para atualizar as notas, os dados cadastrais, etc.<br />

Essa informação é encontrada na documentação das classes, gerada automaticamente pelo <strong>Java</strong><br />

conforme mostra exemplo abaixo:<br />

C:\Felipe\fic\Avaliacao>md docs<br />

C:\Felipe\fic\Avaliacao>javadoc -d docs Avaliacao.java<br />

Loading source file Avaliacao.java...<br />

Constructing <strong>Java</strong>doc information...<br />

Building tree for all the packages and classes...<br />

Building index for all the packages and classes...<br />

Generating docs\overview-tree.html...<br />

Generating docs\index-all.html...<br />

Generating docs\deprecated-list.html...<br />

Building index for all classes...<br />

Generating docs\allclasses-frame.html...<br />

Generating docs\index.html...<br />

Generating docs\packages.html...<br />

Generating docs\Avaliacao.html...<br />

Generating docs\serialized-form.html...<br />

Generating docs\package-list...<br />

Generating docs\help-doc.html...<br />

Generating docs\stylesheet.css...<br />

C:\Felipe\fic\Avaliacao><br />

Os comandos acima executam as seguintes operações:<br />

A primeira linha gera um novo diretório onde serão armazenados os arquivos da documentação: md<br />

(em sistemas operacionais UNIX/Linux, o comando é o mkdir )<br />

49

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!