Solucionado (ver solução)
Solucionado
(ver solução)
1
resposta

Os comentários da Documentações não podem ser redundantes?

Eu criei comentários nos métodos de uma das minhas Classes para colocar coisas há mais no meu projeto, mas no mercado de trabalho, eu imagino que os comentários sejam para explicar códigos que não sejam banais, ou seja, códigos mais complexos. Estou certo?

/**
     * Cada 100 metros dos parâmetros de largura/altura custam R$ 500,00. A conta é feita destes valores para construir o prédio (Regra de Três).
     * @param largura
     * @param altura
     */
    public void construirPredio(float largura, float altura) {
        float precoLargura = (largura * 500) / 100;
        float precoAlura = (altura * 500) / 100;
        float precoConstrucao = precoAlura + precoLargura;

        float tamanhoAndar = altura / 600; //cada apartamento possui 600 metros de altura
        int totalAndares = (int) tamanhoAndar;

        float tamanhoApartamento = largura / 300; //cada apartamento possui 300 metros
        int quantidadeApartamentos = (int) tamanhoApartamento;

        if (this.getReceita().getLucro() >= precoConstrucao) {
            this.getReceita().getReceita().setTotal(this.getReceita().getReceita().getTotal() - precoConstrucao);
            System.out.println("Prédio Construído com Sucesso!");
            System.out.println("Altura do Prédio: " + altura + " metros");
            System.out.println("Largura do Prédio: " + largura + " metros");
            System.out.println("Total de Andares: " + totalAndares);
            System.out.println("Quantidade de Apartamentos por Andar: " + quantidadeApartamentos);
            System.out.println("Custo da Construção: R$ " + precoConstrucao);
        } else {
            System.out.println("Saldo insuficiente para construir prédio!");
        }
    }

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

1 resposta
solução!

Ola Lucas

Sim você está certo, os comentários devem ser usados com moderação e onde convém a explicação de regras. Lembrando que comentário JavaDoc não serve somente para criar a pagina HTML de documentação, mas também para IDEs exibirem para outros devs do mesmo projeto, e assim ajuda-los no entendimento.