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

1. Simplifier les conventions de dénomination

2. Assurer la cohérence

3. Évitez le jargon inutile

4. Utilisez des noms descriptifs basés sur le comportement

5. 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
        }
    }
}

Droite

public class SETIProcessor {

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

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 qu'un nom signifie aux autres développeurs, par exemple lors d'une révision de code.

Balises

• Appellation

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.

Conclusion

La confusion linguistique dans le code conduit à une complexité inutile.

Utilisez un nom clair, cohérent et simple pour rendre votre code plus facile à lire et à maintenir.

Rapports

Code Odeur 22 - Aides

Maxi Contieri ・ 12 novembre 2020

#oop #aides #codenewbie #débutants

Code Smell 38 - Noms abstraits

Maxi Contieri ・ 30 novembre 2020

#oop #codenewbie #appellation #webdev

Code Smell 197 - Contexte gratuit

Maxi Contieri ・ 21 février 23

#webdev #débutants #programmation #tutoriel

Code Smell 113 - Dénomination des données

Maxi Contieri ・ 5 janvier 2022

#oop #webdev #base de données #refactoring

Plus d'informations

Le concept de confusion linguistique de Wittgenstein

Qu'est-ce qui ne va pas avec) le logiciel

Maxi Contieri ・ 8 octobre 2020

#oop #solide #débutants #conception

Qu'est-ce qu'un nom exactement ? — Partie I : La quête

Maxi Contieri ・ 9 février 21

#codenewbie #tutoriel #webdev #oop

Qu'est-ce qu'un nom exactement - Partie II Rehab

Maxi Contieri ・ 23 mai 21

#tutoriel #codenewbie #programmation #webdev

Clause de non-responsabilité

Les odeurs de code sont mon opinion.

Crédits

Photo de Mimi Thian sur Unsplash

Le plus grand ennemi du langage clair est le manque de sincérité.

George Orwell

Citations intéressantes sur le génie logiciel

Maxi Contieri ・ 28 décembre 2020

#codenewbie #programmation #citations #logiciel

Cet article fait partie de la série CodeSmell.

Comment trouver les parties puantes de votre code

Maxi Contieri ・ 21 mai 21

#codenewbie #tutoriel #qualitéducode #débutants