Complicar demasiado los nombres conduce al caos

TL;DR: Dar nombres es difícil, no lo hagas más difícil con complejidad accidental innecesaria.

Problemas

• Nombres poco claros, engañosos, vagos y ambiguos

• Terminología redundante

• Abstracciones confusas

• Abreviaturas crípticas

Soluciones

1. Simplificar las convenciones de nomenclatura

2. Garantizar la coherencia

3. Evitar jerga innecesaria

4. Usar nombres descriptivos según el comportamiento

5. Mantener una terminología coherente

Contexto

Ludwig Wittgenstein argumentó que gran parte de la confusión surge del mal uso del lenguaje.

Esto sucede cuando complicas demasiado los nombres, mezclas metáforas o utilizas terminología inconsistente.

Cuando nombras clases, métodos o variables sin claridad, creas un laberinto lingüístico que a otros les cuesta navegar.

Esto provoca errores, dificulta el mantenimiento y genera frustración en el equipo.

Código de muestra

Equivocado

public class AbstractDataHandlerManager {
    private String dtStr;

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

Bien

public class SETIProcessor {

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

Detección

[X]Manual

Puedes detectar este olor cuando los nombres empiezan a ser largos o cuando ves "Resumen", "Administrador", "Manejador", "Ayudante" o "Datos" con demasiada frecuencia.

Otra señal es cuando debes explicar qué significa un nombre a otros desarrolladores, por ejemplo, en una revisión de código.

Etiquetas

• Nombramiento

Nivel

[X] Principiante

Generación de IA

Los generadores de IA a menudo crean este olor al producir nombres detallados y genéricos que intentan cubrir todos los contextos posibles.

Son expertos en muchos dominios y escriben código, pero frecuentemente no hacen ambas cosas a la vez a menos que se les indique.

Detección de IA

Los generadores de IA a veces pueden solucionar este olor con instrucciones simples de refactorización como "simplificar nombres" o "eliminar términos redundantes", pero tienen dificultades para lograr una comprensión contextual más profunda.

Conclusión

La confusión lingüística en el código genera una complejidad innecesaria.

Utilice nombres claros, consistentes y directos para que su código sea más fácil de leer y mantener.

Relaciones

Código Olor 22 - Ayudantes

Maxi Contieri · 12 de noviembre de 2020

#ups #ayudantes #códigonovato #principiantes

Olor de código 38 - Nombres abstractos

Maxi Contieri · 30 de noviembre de 2020

#ups #códigonovato #nombrar #webdev

Code Smell 197 - Contexto gratuito

Maxi Contieri · 21 de febrero de 23

#webdev #principiantes #programación #tutorial

Code Smell 113 - Nomenclatura de datos

Maxi Contieri · 5 de enero de 22

#ups #webdev #base de datos #refactorización

Más información

El concepto de confusión lingüística de Wittgenstein

¿Qué es (malo) el software?

Maxi Contieri · 8 de octubre de 2020

#ups #sólido #principiantes #diseño

¿Qué es exactamente un nombre? — Parte I: La Búsqueda

Maxi Contieri · 9 de febrero de 21

#códigonovato #tutorial #webdev #ups

¿Qué es exactamente un nombre? Parte II Rehabilitación

Maxi Contieri ・ 23 de mayo '21

#tutorial #códigonovato #programación #webdev

Descargo de responsabilidad

Code Smells es mi opinión.

Créditos

Foto de Mimi Thian en Unsplash

El mayor enemigo del lenguaje claro es la falta de sinceridad.

George Orwell

Excelentes citas de ingeniería de software

Maxi Contieri ・ 28 de diciembre de 2020

#códigonovato #programación #citas #software

Este artículo es parte de la serie CodeSmell.

Cómo encontrar las partes apestosas de tu código

Maxi Contieri ・ 21 de mayo '21

#códigonovato #tutorial #códigocalidad #principiantes