luma-tomazini / api-zoologico

0 stars 0 forks source link

Ajustes nos comentários #2

Open renatoOliveira25 opened 9 months ago

renatoOliveira25 commented 9 months ago

Luma, alguns comentários estão um pouco desorganizados, como por exemplo, os atributos da classe Animal

Você fez assim:

     /**
     * Representa o nome do animal.
     */
     /**
      * Representa a idade do animal.
      */
     /**
      * Representa o gênero do animal.
      */
    private nome: string;
    private idade: number;
    private genero: string;

O correto é fazer assim:

     /**
     * Representa o nome do animal.
     */
    private nome: string;

      /**
      * Representa a idade do animal.
      */
    private idade: number;

      /**
      * Representa o gênero do animal.
      */
    private genero: string;

Outra observação sobre os comentários, é interessante você colocar um comentário para a classe também, assim fica mais fácil pra alguém que pegar o seu código para dar manutenção entender o contexto, por exemplo:

/** 
 * Representa um habitat no zoológico, onde os animais vivem. 
 */ 
export class Habitat {

Lembre-se que você pode usar o ChatGPT para te ajudar a comentar as classes.

Revise suas classes e corrija os comentários que estão errados.

renatoOliveira25 commented 9 months ago

Vou deixar um exemplo de uma classe comentada.

import { Animal } from "./Animal";

/**
 * Representa um habitat no zoológico, onde os animais vivem.
 */
export class Habitat {

    /**
     * O nome do habitat.
     */
    private nome: string;

    /**
     * A lista de animais que habitam este habitat.
     */
    private listaAnimais: Array<Animal>;

    /**
     * Cria uma nova instância de Habitat.
     * 
     * @param _nome O nome do habitat.
     * @param _listaAnimais A lista de animais que habitam o habitat.
     */
    constructor(_nome: string, _listaAnimais: Array<Animal>) {
        this.nome = _nome;
        this.listaAnimais = _listaAnimais;
    }

    /**
     * Obtém o nome do habitat.
     * 
     * @returns O nome do habitat.
     */
    public getNome(): string {
        return this.nome;
    }

    /**
     * Define o nome do habitat.
     * 
     * @param _nome O nome a ser atribuído ao habitat.
     */
    public setNome(_nome: string): void {
        this.nome = _nome;
    }

    /**
     * Obtém a lista de animais do habitat.
     * 
     * @returns A lista de animais do habitat.
     */
    public getListaAnimais(): Array<Animal> {
        return this.listaAnimais;
    }

    /**
     * Define a lista de animais do habitat.
     * 
     * @param _listaAnimais A lista de animais a ser atribuída ao habitat.
     */
    public setListaAnimais(_listaAnimais: Array<Animal>): void {
        this.listaAnimais = _listaAnimais;
    }
}