Odeur de code - Confusion linguistique-javaDidacticiel-php.cn

Odeur de code - Confusion linguistique

王林

Libérer： 2024-08-23 18:01:32

original

1094 Les gens l'ont consulté

Une dénomination trop compliquée mène au chaos

TL;DR : Nommer est difficile, ne compliquez pas les choses avec une complexité accidentelle inutile.

Problèmes

Noms peu clairs, trompeurs, vagues et ambigus
Terminologie redondante
Abstractions déroutantes
Abréviations énigmatiques

Solutions

Simplifier les conventions de dénomination
Assurer la cohérence
Évitez le jargon inutile
Utilisez des noms descriptifs basés sur le comportement
Maintenir une terminologie cohérente

Contexte

Ludwig Wittgenstein a fait valoir qu'une grande confusion découle d'une mauvaise utilisation du langage.

Cela se produit lorsque vous compliquez trop les noms, mélangez des métaphores ou utilisez une terminologie incohérente.

Lorsque vous nommez des classes, des méthodes ou des variables sans clarté, vous créez un labyrinthe linguistique dans lequel d'autres ont du mal à naviguer.

Cela provoque des bugs, rend la maintenance plus difficile et conduit à la frustration de l'équipe.

Exemple de code

Faux

public class AbstractDataHandlerManager {
    private String dtStr;

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

Copier après la connexion

Droite

public class SETIProcessor {

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

Copier après la connexion

Détection

[X] Manuel

Vous pouvez détecter cette odeur lorsque les noms commencent à devenir longs ou lorsque vous voyez trop souvent « Abstrait », « Manager », « Gestionnaire », « Aide » ou « Données ».

Un autre signe est lorsque vous devez expliquer ce que signifie un nom aux autres développeurs, par exemple lors d'une revue de code.

Balises

Nommer

Niveau

[X] Débutant

Génération d'IA

Les générateurs d'IA créent souvent cette odeur en produisant des noms verbeux et génériques qui tentent de couvrir tous les contextes possibles.

Ils sont experts dans de nombreux domaines et écrivent du code, mais souvent ils ne font pas les deux en même temps, sauf indication contraire.

Détection IA

Les générateurs d'IA peuvent parfois corriger cette odeur avec de simples instructions de refactorisation telles que « simplifier les noms » ou « supprimer les termes redondants », mais ont du mal à comprendre le contexte plus profondément.