Odeur de code - Noms des fonctions non impératives-js tutoriel-php.cn

Odeur de code - Noms des fonctions non impératives

DDD

Libérer： 2025-01-10 09:49:41

original

825 Les gens l'ont consulté

Soyez impératif !!

TL;DR : les fonctions dont les noms ne sont pas clairs cachent l'intention et confondent les lecteurs. Utilisez des noms descriptifs et orientés vers l'action.

Problèmes

Objectif de la fonction peu clair
Augmentation de la charge cognitive
Contexte trompeur
Lisibilité réduite
Collaboration difficile
Fonctionnalité cachée

Solutions

Utilisez des verbes orientés vers l'action
Rendre les noms descriptifs
Refléter l'objectif de la fonction
Évitez les termes génériques
Fournir un contexte significatif
Exprimer clairement la responsabilité unique
Faites correspondre l'action au résultat

Refactorisations

Code Smell - Non-Imperative Functions Names

Refactoring 005 - Remplacer le commentaire par le nom de la fonction

Maxi Contieri ・ 7 juin 22

#javascript #débutants #refactorit #programmation

Contexte

Les fonctions nommées avec des termes génériques obligent les lecteurs à se plonger dans l'implémentation pour comprendre leur comportement.

Cela fait perdre du temps et augmente les risques d'erreurs.

La dénomination devient encore plus critique lorsque vous travaillez avec des fonctions autonomes, où le nom de la classe ne fournit pas de contexte supplémentaire.

Ce problème est directement lié au Principe « Dites, ne demandez pas ».

Au lieu d'exposer des comportements ambigus qui obligent l'appelant à déduire des fonctionnalités, les noms impératifs transmettent l'action exacte, guidant le lecteur sans avoir besoin d'inspecter le code.

Lorsque vous nommez les fonctions de manière descriptive, vous éliminez les conjectures inutiles et vous vous alignez sur ce principe.

Exemple de code

Faux

public String dateFormatting(Date date) {
    return new SimpleDateFormat("yyyy-MM-dd").format(date);
}

public void load() {
    System.out.println("Loading...");
}

Copier après la connexion

Droite

public String formatDate(Date date) {
    return new SimpleDateFormat("yyyy-MM-dd").format(date);
}

public void loadUserPreferences() {
    System.out.println("Loading user preferences...");
}

Copier après la connexion

Détection

[X] Manuel

Vous pouvez détecter cette odeur en examinant les noms de fonctions qui utilisent des termes vagues comme do, run, processus, load, etc. .

Les linters automatisés peuvent signaler ces modèles ou mettre en évidence des fonctions avec des noms trop génériques.

Balises

Nommer

Niveau

[X] Débutant

Pourquoi la bijection est importante

Les noms de fonctions doivent créer une correspondance claire et univoque entre leur nom et leur fonctionnalité.

Briser cette bijection oblige les développeurs à examiner les détails du code pour le contexte, ce qui ralentit le débogage, les révisions et les extensions.

Génération d'IA

Les outils d'IA génèrent parfois des noms de fonctions génériques sans comprendre votre domaine.

Lorsque vous utilisez l'IA, précisez que les noms de fonctions doivent être descriptifs et orientés vers l'action.

Détection IA

Les modèles d'IA peuvent aider à détecter les noms ambigus en comparant les signatures de fonction avec les meilleures pratiques de dénomination prédéfinies.

La combinaison de l'IA avec la révision manuelle du code donne les meilleurs résultats.