Buscar

Então para que servem comentários? Um bom código nunca terá comentários? Não é bem assim. Algumas informações não conseguem ser expressas no código...

Então para que servem comentários? Um bom código nunca terá comentários? Não é bem assim. Algumas informações não conseguem ser expressas no código, mas precisam ser passadas para quem está o lendo. Essas informações podem ser avisos em geral (por exemplo, que um algoritmo toma muito tempo), avisos de que o código está incompleto (colocando um comentário que há algo “a fazer” – representados normalmente como um TODO, do inglês “to do”), explicações do motivo do código ser assim (por exemplo, que um código varre um arranjo de trás para frente porque normalmente o valor procurado está no final do arranjo), entre outras. Portanto, só escreva um comentário se ele acrescentar algo que não pode ser expresso na linguagem de programação.


Essa pergunta também está no material:

semana 5 texto base qualidade-de-codigo
8 pág.

Código de Henriqueta Vialta SaadHenriqueta Vialta Saad

Respostas

User badge image

Ed Verified user icon

Comentários em código servem para fornecer informações adicionais sobre o funcionamento do código, explicar trechos complexos, fornecer avisos ou instruções para outros desenvolvedores que possam trabalhar no mesmo projeto. Embora um bom código seja autoexplicativo, existem situações em que é necessário adicionar comentários para tornar o código mais compreensível. Comentários podem ser usados para explicar a lógica por trás de uma determinada implementação, documentar decisões de design, fornecer exemplos de uso de funções ou classes, entre outros. No entanto, é importante evitar comentários desnecessários ou redundantes, pois eles podem tornar o código confuso. O ideal é escrever comentários claros, concisos e relevantes, que realmente acrescentem informações úteis ao código.

0
Dislike0

Responda

SetasNegritoItálicoSublinhadoTachadoCitaçãoCódigoLista numeradaLista com marcadoresSubscritoSobrescritoDiminuir recuoAumentar recuoCor da fonteCor de fundoAlinhamentoLimparInserir linkImagemFórmula

Para escrever sua resposta aqui, entre ou crie uma conta

User badge image

Continue navegando