| name | no-comments |
| description | Deixa o código falar — não escreve comentário que repete o que o código já diz |
| roles | ["builder"] |
| category | opinion |
Não escreva comentários que descrevem o que o código faz. Apenas:
- Por quê não-óbvio (constraint escondida, decisão contraintuitiva).
- TODO/FIXME com contexto e dono.
- Workaround de bug externo (cite issue ou PR).
Antes de comentar, prefira:
- Renomear variáveis pra deixar a intenção explícita.
- Extrair função com nome que descreve a intenção.
- Separar o passo em uma constante nomeada.
Docstring de API pública é OK e desejável; comentário inline redundante não.