Odeur de code – Balises méta non résolues

Les balises méta incomplètes ne sont pas professionnelles

TL;DR : les balises méta incomplètes ou nulles interrompent la fonctionnalité et l'expérience utilisateur.

Problèmes

• Les balises apparaissent dans la sortie
• Les textes des e-mails incluent des espaces réservés entre le texte lisible par l'homme
• Les espaces réservés manqués confondent les utilisateurs
• Les sites Web sont rendus avec des caractères étranges
• Les valeurs nulles déclenchent des erreurs
• Vulnérabilités potentielles d’injection de sécurité

Solutions

1. Valider les balises méta
2. Affirmer l'exhaustivité dès le début
3. Échouer rapidement
4. Évitez les valeurs nulles
5. Lancez des exceptions significatives
6. Automatiser la méta-validation

Contexte

Lorsque vous laissez les balises méta inachevées, telles que {user_name} ou {product_name}, elles se faufilent souvent dans votre résultat final. Imaginez que vous envoyiez un e-mail disant : "Bonjour {user_name}, votre commande de {product_name} est prête."

Cela crie au manque de professionnalisme et déroute les utilisateurs.

Les valeurs nulles aggravent les choses en provoquant des plantages ou des échecs silencieux, conduisant à de mauvaises expériences utilisateur ou à des processus interrompus.

Vous pouvez éviter cela en affirmant l'exhaustivité avant le rendu ou l'envoi.

Lorsque votre code trouve une balise méta incomplète ou une valeur nulle, arrêtez immédiatement le processus et lancez une exception.

Exemple de code

Faux

<?php

$emailBody = "Hello {user_name}, 
your order for {product_name} is confirmed.";

// You forget to make the replacements
sendEmail($emailBody);

Droite

<?php

$emailBody = "Hello {user_name},
your order for {product_name} is confirmed.";

if (strpos($emailBody, '{') !== false) {
    throw new Exception(
        "Incomplete meta tags found in email body.");
}
sendEmail($emailBody);

Détection

[X] Automatique

Vous pouvez détecter cette odeur avec des tests automatisés ou des linters analysant des espaces réservés inachevés ({} ou des modèles similaires).

Balises

• Échouer rapidement

Niveau

[X] Débutant

Pourquoi la bijection est importante

Votre système doit conserver un mappage un-à-un lors de la représentation des données utilisateur avec des espaces réservés.

Vous rompez ce mappage si votre espace réservé {user_name} existe mais n'a pas de vrai nom correspondant.

Cela provoque des erreurs, de la confusion et une perte de confiance dans votre candidature.

Assurer la conformité de la bijection évite ces problèmes.

Génération d'IA

Les outils d'IA introduisent parfois cette odeur lors de la génération de modèles avec des espaces réservés, mais ne parviennent pas à remplacer les données réelles.

Vous devez valider et compléter tous les espaces réservés avant d'utiliser la sortie.

Détection IA

Les outils d'IA comme les linters ou les validateurs de rendu d'e-mails peuvent détecter les balises méta inachevées si vous les configurez correctement.

Utilisez ces outils pour automatiser la détection des balises méta et réduire les erreurs humaines.

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 balises méta incomplètes sont plus que bâclées : elles sont nuisibles. Validez les balises, affirmez l'exhaustivité et lancez des exceptions si nécessaire.

La gestion minutieuse des balises méta évite les erreurs et garantit une expérience professionnelle.

Rapports

Code Odeur 12 - Null

Maxi Contieri ・ 31 octobre 2020

#codenewbie #tutoriel #oop

Code Smell 139 - Code commercial dans l'interface utilisateur

Maxi Contieri ・ 9 juin 22

#oop #webdev #javascript #débutants

Code Smell 97 - Messages d'erreur sans empathie

Maxi Contieri ・ 27 octobre 21

#opensource #ux #programmation #javascript

Plus d'informations

Échouer rapidement

Maxi Contieri ・ 6 décembre 20

#codenewbie #programmation #webdev #oop

Nul : L'erreur d'un milliard de dollars

Maxi Contieri ・ 18 novembre 2020

#codenewbie #tutoriel #programmation #webdev

Clause de non-responsabilité

Les odeurs de code sont mon opinion.

Crédits

Photo de Tomas Martinez sur Unsplash

---

Le meilleur message d'erreur est celui qui n'apparaît jamais.

Thomas Fuchs

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!