Documentação com Javadoc <ul><ul><li>Regis Pires Magalhães </li></ul></ul><ul><ul><li>[email_address] </li></ul></ul>
Problema <ul><li>Como saber quais classes podemos usar? Quais os seus métodos e o que eles fazem? </li></ul><ul><ul><li>At...
Geração de Javadoc <ul><li>A partir do Eclipse </li></ul><ul><ul><li>Menu Project > Generate Javadoc </li></ul></ul><ul><u...
Javadoc <ul><ul><li>O Javadoc é criado a partir de comentários delimitados por /** e */. </li></ul></ul><ul><ul><li>Linhas...
Javadoc /** *   Metodo   que   incrementa   o   saldo. *   *   @param   valor */ public   void  deposita( double  valor) {
Javadoc
Comentários em Java <ul><ul><li>Comentários de linha </li></ul></ul><ul><ul><ul><li>Iniciam com duas barras consecutivas (...
Comentários em Java //Exemplo de comentário de linha //Outra linha de comentário /* Exemplo de comentário  * em bloco que ...
Documentação com Javadoc <ul><li>Sintaxe </li></ul><ul><ul><li>Possui um conjunto  doc tags  que são comandos iniciados po...
Documentação /** *   Classe   base   responsável   pelo   armazenamento   das *   informações   do   cliente   da   loja. ...
HTML embutido <ul><ul><li>javadoc  passa todo código HTML contido no comentário para o HTML gerado </li></ul></ul><ul><ul>...
doc tags <ul><ul><li>@see –  faz referência à documentação de outra classe </li></ul></ul><ul><ul><ul><li>@see nome-da-cla...
doc tags <ul><ul><li>{@inheritDoc} –  herda   o comentário de uma superclasse dentro do comentário corrente </li></ul></ul...
doc tags <ul><ul><li>@author –  informação sobre o autor da classe </li></ul></ul><ul><ul><li>@since –  permite informar a...
doc tags <ul><ul><li>@param –  usada na documentação de métodos. Permite fazer uma descrição da lista de parâmetros de um ...
doc tags <ul><ul><li>@deprecated –  indica que o elemento relacionado será substituído  por outro melhorado </li></ul></ul>
Parte integrante do JDK <ul><li>Sinopse: </li></ul><ul><ul><li>javadoc [ options ] [ packagenames ] [ sourcefilenames ] [ ...
Upcoming SlideShare
Loading in...5
×

Java 14 Javadoc

2,409

Published on

0 Comments
1 Like
Statistics
Notes
  • Be the first to comment

No Downloads
Views
Total Views
2,409
On Slideshare
0
From Embeds
0
Number of Embeds
0
Actions
Shares
0
Downloads
100
Comments
0
Likes
1
Embeds 0
No embeds

No notes for slide

Java 14 Javadoc

  1. 1. Documentação com Javadoc <ul><ul><li>Regis Pires Magalhães </li></ul></ul><ul><ul><li>[email_address] </li></ul></ul>
  2. 2. Problema <ul><li>Como saber quais classes podemos usar? Quais os seus métodos e o que eles fazem? </li></ul><ul><ul><li>Através de alguma documentação. </li></ul></ul><ul><li>A documentação do Java pode ser acessada via Internet a partir do endereço: </li></ul><ul><ul><li>http://java.sun.com/javase/6/docs/api/ </li></ul></ul><ul><li>Javadoc: </li></ul><ul><ul><li>Quadro superior esquerdo: pacotes </li></ul></ul><ul><ul><li>Quadro inferior esquerdo: classes e interfaces. </li></ul></ul><ul><ul><li>Quadro da direita: detalhes do que foi escolhido. </li></ul></ul><ul><ul><li>Métodos e atributos privados não aparecem. </li></ul></ul><ul><ul><li>Podemos gerar nossos próprios javadoc a partir da linha de comando, usando o comando javadoc. </li></ul></ul>
  3. 3. Geração de Javadoc <ul><li>A partir do Eclipse </li></ul><ul><ul><li>Menu Project > Generate Javadoc </li></ul></ul><ul><ul><li>Ou pelo export do projeto. </li></ul></ul>
  4. 4. Javadoc <ul><ul><li>O Javadoc é criado a partir de comentários delimitados por /** e */. </li></ul></ul><ul><ul><li>Linhas entre os delimitadores apenas precisam de um *. </li></ul></ul><ul><ul><li>Nos comentários podemos definir autor, versão, parâmetros, retorno, etc. </li></ul></ul>/** * Classe responsavel por moldar as Contas do Banco * * @author Guilherme * */ public abstract class Conta {
  5. 5. Javadoc /** * Metodo que incrementa o saldo. * * @param valor */ public void deposita( double valor) {
  6. 6. Javadoc
  7. 7. Comentários em Java <ul><ul><li>Comentários de linha </li></ul></ul><ul><ul><ul><li>Iniciam com duas barras consecutivas ( // ) e continuam até o final da linha </li></ul></ul></ul><ul><ul><li>Comentários em bloco </li></ul></ul><ul><ul><ul><li>Iniciam com a seqüência barra asterisco ( /* ) e encerram com a seqüência inversa asterisco barra ( */ ) </li></ul></ul></ul><ul><ul><ul><li>Podem se estender por mais de uma linha </li></ul></ul></ul><ul><ul><ul><li>Comumente usa-se um asterisco no início de cada linha que compõe o comentário </li></ul></ul></ul>
  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 <ul><li>Sintaxe </li></ul><ul><ul><li>Possui um conjunto doc tags que são comandos iniciados por @ e divididas em dois subconjuntos: </li></ul></ul><ul><ul><ul><li>Standalone doc tags devem estar no início de cada linha </li></ul></ul></ul><ul><ul><ul><li>In line doc tags podem aparecer em qualquer parte do javadoc e devem vir entre chaves {...} </li></ul></ul></ul><ul><ul><li>Aceita HTML embutido. </li></ul></ul>
  10. 10. Documentação /** * Classe base responsável pelo armazenamento das * informações do cliente da loja. * @autor Fulano * @version 1.0 */ public class Pessoa { /** * Identidicador único do Cliente no sistema */ private int id ; ... /** * Construtor ... */ public Pessoa() { ... } /** * Fornece o identificador único do cliente * @return Número que identifica o clienete no sistema */ public int getId(){ return id ; } // ... }
  11. 11. HTML embutido <ul><ul><li>javadoc passa todo código HTML contido no comentário para o HTML gerado </li></ul></ul><ul><ul><li>Usado para formatar o comentário </li></ul></ul><ul><ul><li>Exemplo: </li></ul></ul>/** * <pre> * System.out.println(new Date()); * </pre> */ /** * Você pode <b> inserir </b> listas: * <ol> * <li> Item um * <li> Item dois * <li> Item três * </ol> */
  12. 12. doc tags <ul><ul><li>@see – faz referência à documentação de outra classe </li></ul></ul><ul><ul><ul><li>@see nome-da-classe </li></ul></ul></ul><ul><ul><ul><li>@see nome-completamente-qualificado </li></ul></ul></ul><ul><ul><ul><li>@see nome-completamente-qualificado#nome-metodo </li></ul></ul></ul><ul><ul><li>Gera o link “See Also” na documentação </li></ul></ul><ul><ul><li>{@link} – semelhante à tag see, exceto pelo fato de poder ser usada inline e permitir a adição de um rótulo </li></ul></ul><ul><ul><ul><li>{@link nome-completamente-qualificado#nome-metodo rotulo} </li></ul></ul></ul><ul><ul><li>{@docRoot} - fornece um path relativo para o diretório raiz da documentação gerada </li></ul></ul>/** * Veja o <a href=&quot;{@docRoot}/copyright.html&quot;>Copyright </a> . */
  13. 13. doc tags <ul><ul><li>{@inheritDoc} – herda o comentário de uma superclasse dentro do comentário corrente </li></ul></ul><ul><ul><li>@version – informação sobre a versão da classe </li></ul></ul>
  14. 14. doc tags <ul><ul><li>@author – informação sobre o autor da classe </li></ul></ul><ul><ul><li>@since – permite informar a versão do código a partir da qual um característica e suportada </li></ul></ul>
  15. 15. doc tags <ul><ul><li>@param – usada na documentação de métodos. Permite fazer uma descrição da lista de parâmetros de um método </li></ul></ul><ul><ul><li>@return – usada na documentação de métodos. Permite fazer uma descrição do retorno do método </li></ul></ul>
  16. 16. doc tags <ul><ul><li>@deprecated – indica que o elemento relacionado será substituído por outro melhorado </li></ul></ul>
  17. 17. Parte integrante do JDK <ul><li>Sinopse: </li></ul><ul><ul><li>javadoc [ options ] [ packagenames ] [ sourcefilenames ] [ @argfiles ] </li></ul></ul><ul><ul><ul><li>options: Opções de linha de comando </li></ul></ul></ul><ul><ul><ul><li>packagenames: lista de nomes de pacotes, separados por espaço, que deverão ser documentados </li></ul></ul></ul><ul><ul><ul><li>sourcefilenames: lista de nomes de arquivos, separados por espaço. Javadoc processará todos os arquivos terminados com .java </li></ul></ul></ul><ul><ul><ul><li>@argfiles: um ou mais arquivos que contém opções Javadoc, lista de pacotes ou lista de arquivos fontes em qualquer ordem </li></ul></ul></ul>
  1. A particular slide catching your eye?

    Clipping is a handy way to collect important slides you want to go back to later.

×