A apresentação está carregando. Por favor, espere

A apresentação está carregando. Por favor, espere

1 Documentando con Javadoc. 2 Problema Como saber quais classes podemos usar? Quais os seus métodos e o que eles fazem? Através de alguma documentação.

Apresentações semelhantes


Apresentação em tema: "1 Documentando con Javadoc. 2 Problema Como saber quais classes podemos usar? Quais os seus métodos e o que eles fazem? Através de alguma documentação."— Transcrição da apresentação:

1 1 Documentando con Javadoc

2 2 Problema Como saber quais classes podemos usar? Quais os seus métodos e o que eles fazem? Através de alguma documentação. A documentação do Java pode ser acessada via Internet a partir do endereço: Javadoc: Quadro superior esquerdo: pacotes Quadro inferior esquerdo: classes e interfaces. Quadro da direita: detalhes do que foi escolhido. Métodos e atributos privados não aparecem. Podemos gerar nossos próprios javadoc a partir da linha de comando, usando o comando javadoc.

3 3 Geração de Javadoc A partir do Eclipse Menu Project > Generate Javadoc Ou pelo export do projeto.

4 4 Javadoc O Javadoc é criado a partir de comentários delimitados por /** e */. Linhas entre os delimitadores apenas precisam de um *. Nos comentários podemos definir autor, versão, parâmetros, retorno, etc. /** * Classe responsavel por moldar as Contas do Banco * Guilherme * */ public abstract class Conta {

5 5 Javadoc /** * Metodo que incrementa o saldo. * valor */ public void deposita(double valor) {

6 6 Javadoc

7 7 Comentários em Java Comentários de linha Iniciam com duas barras consecutivas (//) e continuam até o final da linha Comentários em bloco Iniciam com a seqüência barra asterisco (/*) e encerram com a seqüência inversa asterisco barra (*/) Podem se estender por mais de uma linha Comumente usa-se um asterisco no início de cada linha que compõe o comentário

8 8 Comentários em Java //Exemplo de comentário de linha //Outra linha de comentário /* Exemplo de comentário * em bloco que se estende por mais * de uma linha */ /* Outro exemplo de comentário em bloco */

9 9 Documentação com Javadoc Sintaxe Possui um conjunto doc tags que são comandos iniciados e divididas em dois subconjuntos: Standalone doc tags devem estar no início de cada linha In line doc tags podem aparecer em qualquer parte do javadoc e devem vir entre chaves {...} Aceita HTML embutido.

10 10 Documentação /** * Classe base responsável pelo armazenamento das * informações do cliente da loja. Fulano 1.0 */ public class Pessoa { /** * Identidicador único do Cliente no sistema */ private int id;... /** * Construtor... */ public Pessoa() {... } /** * Fornece o identificador único do cliente Número que identifica o clienete no sistema */ public int getId(){ return id; } //... }

11 11 HTML embutido javadoc passa todo código HTML contido no comentário para o HTML gerado Usado para formatar o comentário Exemplo: /** * * System.out.println(new Date()); * */ /** * Você pode inserir listas: * * Item um * Item dois * Item três * */

12 12 doc – faz referência à documentação de outra nome-completamente-qualificado#nome-metodo Gera o link See Also na documentação – semelhante à tag see, exceto pelo fato de poder ser usada inline e permitir a adição de um rótulo nome-completamente-qualificado#nome-metodo rotulo} - fornece um path relativo para o diretório raiz da documentação gerada /** * Veja o Copyright. */

13 13 doc tags – herda o comentário de uma superclasse dentro do comentário – informação sobre a versão da classe /** * Insere as informações no Banco de Dados. */ public void save(Pessoa pessoa) /** * Classe responsável pela persistência das informações. * 1.2 */ public class PessoaBD{... }

14 14 doc – informação sobre o autor da – permite informar a versão do código a partir da qual um característica e suportada /** * Classe responsável pela persistência das informações. * Fulano da Silva Beltrano da Silva */ public class PessoaBD{...} /** * Insere as informações no Banco de Dados. * 1.2 */ public void save(Pessoa pessoa)

15 15 doc – usada na documentação de métodos. Permite fazer uma descrição da lista de parâmetros de um – usada na documentação de métodos. Permite fazer uma descrição do retorno do método /** * Insere as informações no Banco de Dados. * pessoa Objeto que contém as informações usuario Usuario responsável pela operação 1.2 */ public void insert(Pessoa pessoa, Usuario usuario) /** * Lista todos as pessoas cadastradas * Uma lista formada por todas as pessoas cadastradas */ public List findAll(){...}

16 16 doc – indica que o elemento relacionado será substituído por outro melhorado /** * Insere as informações no Banco de Dados. * pessoa Objeto que comtém as informações */ public void insert(Pessoa pessoa)

17 17 Parte integrante do JDK Sinopse: javadoc [ options ] [ packagenames ] [ sourcefilenames ] ] options: Opções de linha de comando packagenames: lista de nomes de pacotes, separados por espaço, que deverão ser documentados sourcefilenames: lista de nomes de arquivos, separados por espaço. Javadoc processará todos os arquivos terminados um ou mais arquivos que contém opções Javadoc, lista de pacotes ou lista de arquivos fontes em qualquer ordem


Carregar ppt "1 Documentando con Javadoc. 2 Problema Como saber quais classes podemos usar? Quais os seus métodos e o que eles fazem? Através de alguma documentação."

Apresentações semelhantes


Anúncios Google