Odeur de code - Noms des fonctions non impératives

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

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

Refactorisations

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...");
}

Droite

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

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

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.

Essayez-les !

Rappelez-vous : les assistants IA font beaucoup d'erreurs

Without Proper Instructions	With Specific Instructions
ChatGPT	ChatGPT
Claude	Claude
Perplexity	Perplexity
Copilot	Copilot
Gemini	Gemini

Conclusion

Les noms de fonctions ne sont pas de simples étiquettes ; ce sont des contrats avec le lecteur.

Les noms ambigus rompent ce contrat et prêtent à confusion.

Les noms descriptifs et orientés vers l'action simplifient la communication et facilitent la maintenance et l'extension de votre code.

Rapports

Code Odeur 33 - Abréviations

Maxi Contieri ・ 24 novembre 2020

#oop #codenewbie #programmation #tutoriel

Code Odeur 153 - Noms trop longs

Maxi Contieri ・ 29 juillet 22

#javascript #webdev #débutants #programmation

Code Smell 38 - Noms abstraits

Maxi Contieri ・ 30 novembre 2020

#oop #codenewbie #appellation #webdev

Code Smell 174 - Nom de la classe dans les attributs

Maxi Contieri ・ 29 octobre 22

#javascript #webdev #débutants #programmation

Voir aussi

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 Réadaptation

Maxi Contieri ・ 23 mai '21

#tutoriel #codenewbie #programmation #webdev

Clause de non-responsabilité

Les odeurs de code sont mon opinion.

Crédits

Photo par britishlibrary sur Unsplash

---

Un nom de fonction doit être un verbe ou une phrase verbale, et il doit l'être
significatif

Robert C. Martin

Citations intéressantes sur le génie logiciel

Maxi Contieri ・ 28 décembre 20

#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

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!