devterview_$ iniciar simulação

Comentário bom x comentário que é desculpa

FácilJúniorLegibilidade

Pergunta

Quando um comentário no código agrega valor e quando ele é sinal de um problema que deveria ser resolvido no código?

Resposta esperada

Comentário útil explica o que o código não consegue dizer: o porquê de uma decisão não óbvia ('usamos busca linear aqui porque a lista nunca passa de 5 itens e o índice custaria mais'), um aviso de consequência ('não reordene: a API do fornecedor exige esta sequência'), contexto externo (link pra um bug/RFC), ou um TODO com dono. Comentário ruim: repete o que o código já diz (`i++ // incrementa i`), explica um nome ou um trecho confuso que deveria ser renomeado/extraído, ou está desatualizado e mente. Regra: primeiro tente tornar o código autoexplicativo (nome, função extraída); comente só o que sobra — geralmente o 'porquê', não o 'o quê'.

Por que perguntam isso

Pergunta pleno. Sinal de maturidade: 'comentário explica porquê, não o quê' e 'comentário que explica código confuso deveria ser uma refatoração'.

#comentarios#legibilidade
publicidade

Relacionadas