Nomenclatura complicada leva ao caos

TL;DR: Nomear é difícil, não torne isso mais difícil com complexidade acidental desnecessária.

Problemas

• Nomes pouco claros, enganosos, vagos e ambíguos

• Terminologia redundante

• Abstrações confusas

• Abreviações enigmáticas

Soluções

1. Simplifique as convenções de nomenclatura

2. Garantir consistência

3. Evite jargões desnecessários

4. Use nomes descritivos com base no comportamento

5. Mantenha uma terminologia consistente

Contexto

Ludwig Wittgenstein argumentou que muita confusão surge do uso indevido da linguagem.

Isso acontece quando você complica nomes, mistura metáforas ou usa terminologia inconsistente.

Quando você nomeia classes, métodos ou variáveis ​​sem clareza, você cria um labirinto linguístico no qual outros têm dificuldade para navegar.

Isso causa bugs, dificulta a manutenção e leva à frustração da equipe.

Código de amostra

Errado

public class AbstractDataHandlerManager {
    private String dtStr;

    public void execProcessingOps(String input) {
        if (dtStr != null && !dtStr.isEmpty()) {
            // process
        }
    }
}

Certo

public class SETIProcessor {

    public void processSignal(String input) {      
            // process
        }
    }
}

Detecção

[X]Manual

Você pode detectar esse cheiro quando os nomes começam a ficar longos ou quando você vê "Resumo", "Gerente", "Manipulador", "Ajudante" ou "Dados" com muita frequência.

Outro sinal é quando você deve explicar o que um nome significa para outros desenvolvedores, por exemplo, em uma revisão de código.

Etiquetas

• Nomeação

Nível

[X] Iniciante

Geração de IA

Os geradores de IA geralmente criam esse cheiro ao produzir nomes detalhados e genéricos que tentam cobrir todos os contextos possíveis.

Eles são especialistas em muitos domínios e escrevem código, mas frequentemente não fazem as duas coisas ao mesmo tempo, a menos que sejam instruídos.

Detecção de IA

Os geradores de IA às vezes podem corrigir esse cheiro com instruções simples de refatoração, como "simplificar nomes" ou "remover termos redundantes", mas lutam com uma compreensão contextual mais profunda.

Conclusão

A confusão linguística no código leva a uma complexidade desnecessária.

Use uma nomenclatura clara, consistente e direta para tornar seu código mais fácil de ler e manter.

Relações

Código Cheiro 22 - Ajudantes

Maxi Contieri ・ 12 de novembro de 20

#ops #ajudantes #codenewbie #iniciantes

Code Smell 38 - Nomes abstratos

Maxi Contieri ・ 30 de novembro de 2020

#ops #codenewbie #nomeação #webdev

Código Smell 197 - Contexto Gratuito

Maxi Contieri ・ 21 de fevereiro de 23

#webdev #iniciantes #programação #tutorial

Code Smell 113 - Nomenclatura de dados

Maxi Contieri ・ 5 de janeiro de 22

#ops #webdev #banco de dados #refatoração

Mais informações

O conceito de confusão linguística de Wittgenstein

O que há de (errado com) software

Maxi Contieri ・ 8 de outubro de 2020

#ops #sólido #iniciantes #projeto

O que exatamente é um nome? — Parte I: A Busca

Maxi Contieri ・ 9 de fevereiro de 21

#codenewbie #tutorial #webdev #ops

O que exatamente é um nome - Parte II Reabilitação

Maxi Contieri ・ 23 de maio de 21

#tutorial #codenewbie #programação #webdev

Isenção de responsabilidade

Os cheiros de código são minha opinião.

Créditos

Foto de Mimi Thian no Unsplash

O maior inimigo da linguagem clara é a falta de sinceridade.

George Orwell

Ótimas citações de engenharia de software

Maxi Contieri ・ 28 de dezembro de 2020

#codenewbie #programação #citações #software

Este artigo faz parte da série CodeSmell.

Como encontrar as partes fedorentas do seu código

Maxi Contieri ・ 21 de maio de 21

#codenewbie #tutorial #qualidadedecódigo #iniciantes