---
title: "Comentários"
type: "code-smell"
slug: "comments"
url: "http://localhost:3000/pt-br/smells/comments.md"
category: "Dispensables"
description: "Um método está repleto de comentários explicativos."
---
# Comentários

> Um método está repleto de comentários explicativos.

## Signs and Symptoms

Um método está repleto de comentários explicativos.

## Reasons for the Problem

Os comentários geralmente são criados com as melhores intenções, quando o autor percebe que seu código não é intuitivo ou óbvio. Nesses casos, os comentários são como um desodorante que mascara o cheiro de um código suspeito que poderia ser melhorado.

> O melhor comentário é um bom nome para um método ou classe.

Se você acha que um trecho de código não pode ser entendido sem comentários, tente alterar a estrutura do código de uma forma que torne os comentários desnecessários.

## Payoff

* O código se torna mais intuitivo e evidente.
## Relations

**Treated by**

- [Extrair Variável](/pt-br/extract-variable.md)
- [Extrair Método](/pt-br/extract-method.md)
- [Renomear Método](/pt-br/rename-method.md)
- [Introduzir Asserção](/pt-br/introduce-assertion.md)


## Detected by

- **pmd** `CommentSize` — Comment too large (https://docs.pmd-code.org/latest/pmd_rules_java_documentation.html#commentsize)