1
resposta

Criação do Javadoc no VScode

Olá, eu uso o VSCode e estou com dificuldade em seguir com as coordenadas dadas pelo professor para criar o javadoc. Inclusive vi esse vídeo que indicaram em um tópico antigo: https://www.youtube.com/watch?v=xIHNUId9RdM e consegui criar apenas a documentação de uma classe(conta) e não de todas, junto com os packages como o Nico mostra em aula, o meu index vem assim: print do index Alguém pode me ajudar, por favor?

1 resposta

Boa noite Camila, tudo bem?

Inicialmente para gerar as informações Javadoc voce precisar comentar os códigos da classe.

Comentários Javadoc são comentários que documentam o código especifica.

Exemplo:

/**

  • @author Fernando * */

Podemos gerar comentários, de varios itens, declaração de classes, métodos construtores, métodos comuns, para isso basta criar o comentário em cima d item que deseja documentar.

Para dar detalhes utilizamos anotações com "@", segue a lista:

@author (classes e interfaces) @version (classes e interfaces) @param (metodos e construtores) @return (metodos) @throws (exceçoes)

Exemplo:

package br.com.bytebank.banco.model;

/**
 * Classe Conta
 * @
 * @author Fernando
 *
 */
public abstract class Conta {

    protected double saldo;
    private int agencia;
    private int numero;
    private Cliente titular;
    private static int total = 0;

    /**
     * Método construtor Conta
     * @param agencia
     * @param numero
     */
    public Conta(int agencia, int numero) {
        Conta.total++;
        // System.out.println("O total de contas é " + Conta.total);
        this.agencia = agencia;
        this.numero = numero;
        // this.saldo = 100;
        // System.out.println("Estou criando uma conta " + this.numero);
    }

    /**
     * Método abstrato deposita
     * @param valor
     */
    public abstract void deposita(double valor);

    /**
     * Método comum saca
     * @param valor
     * @throws SaldoInsuficienteException
     */
    public void saca(double valor) throws SaldoInsuficienteException {

        if (this.saldo < valor) {
            throw new SaldoInsuficienteException("Saldo: " + this.saldo + ", Valor: " + valor);
        }

        this.saldo -= valor;
    }

    /**
     * Método comum transfere
     * @param valor
     * @param destino
     * @throws SaldoInsuficienteException
     */
    public void transfere(double valor, Conta destino) throws SaldoInsuficienteException {
        this.saca(valor);
        destino.deposita(valor);
    }

    /**
     * Método getSaldo
     * @return
     */
    public double getSaldo() {
        return this.saldo;
    }

    /**
     * Método getNumero
     * @return
     */
    public int getNumero() {
        return this.numero;
    }

    /**
     * Método setNumero
     * @param numero
     */
    public void setNumero(int numero) {
        if (numero <= 0) {
            System.out.println("Nao pode valor menor igual a 0");
            return;
        }
        this.numero = numero;
    }

    /**
     * Método getAgencia
     * @return
     */
    public int getAgencia() {
        return this.agencia;
    }

    /**
     * Método setAgencia
     * @param agencia
     */
    public void setAgencia(int agencia) {
        if (agencia <= 0) {
            System.out.println("Nao pode valor menor igual a 0");
            return;
        }
        this.agencia = agencia;
    }

    /**
     * Método setTitular
     * @param titular
     */
    public void setTitular(Cliente titular) {
        this.titular = titular;
    }

    /**
     * Método getTitular
     * @return
     */
    public Cliente getTitular() {
        return this.titular;
    }

    /**
     * Método getTotal
     * @return
     */
    public static int getTotal() {
        return Conta.total;
    }

    /**
     * Método toString
     */
    @Override
    public String toString() {
        return "Agencia= " + agencia + ", numero= " + numero;
    }

}

A pagina deste codigo acima ficou desta forma abaixo que mostra os pacotes:

Insira aqui a descrição dessa imagem para ajudar na acessibilidadeClicando no pacote "model" foi apresentada a imagem abaixo com as classes:

Insira aqui a descrição dessa imagem para ajudar na acessibilidade

Dentro da classe conta viream as informações:

Insira aqui a descrição dessa imagem para ajudar na acessibilidade

Recomendo analisar seu codigo para validar se os comentarios Javadoc estao OK, eles podem estar com algum erro na declaração.

Como ultima opção da para voce criar a Javadoc pelo prompt mas nao recomendo.

Infelizmente outra coisa que nao recomendo no inicio é o uso do VScode para programar em Java, em comparação ao Eclipse ele fica muito aquem, talvez ate o problema ao gera a documentação possa estar no VSCode.

Quando tiver mais experiencia ate não vejo problema em usar o VSCode mas no inicio ele fica devendo em relação a autocomplete, documentação, recursos, etc.

Abraço!

Quer mergulhar em tecnologia e aprendizagem?

Receba a newsletter que o nosso CEO escreve pessoalmente, com insights do mercado de trabalho, ciência e desenvolvimento de software