代码气味 - 未解析的元标签

不完整的元标签是不专业的

问题

解决方案

1. 验证元标记
2. 尽早断言完整性
3. 快速失败
4. 避免空值
5. 抛出有意义的异常
6. 自动元验证

语境

当您留下未完成的元标记（例如 {user_name} 或 {product_name}）时，它们通常会潜入您的最终输出中。想象一下发送一封电子邮件，内容是：“您好 {user_name}，您的 {product_name} 订单已准备就绪。”

它让人尖叫不专业并且让用户感到困惑。

空值会导致崩溃或静默故障，从而导致糟糕的用户体验或进程中断，从而使情况变得更糟。

您可以通过在渲染或发送之前断言完整性来避免这种情况。

当您的代码发现不完整的元标记或空值时，立即停止进程并抛出异常。

示例代码

错误的

<?php$emailbody = "hello {user_name}, your order for {product_name} is confirmed.";// you forget to make the replacementssendemail($emailbody);

正确的

<?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);

检测

[x] 自动

您可以通过自动化测试或短绒扫描未完成的占位符（{} 或类似模式）来检测这种气味。

标签

等级

[x] 初学者

为什么双射很重要

在使用占位符表示用户数据时，您的系统必须维护一对一的映射。

如果您的 {user_name} 占位符存在但缺少相应的真实姓名，则您将破坏此映射。

这会导致错误、混乱以及对您的应用程序失去信任。

确保双射合规性可以避免这些问题。

人工智能一代

人工智能工具有时会在生成带有占位符的模板时引入这种气味，但无法替换真实数据。

在使用输出之前，您必须验证并完成所有占位符。

人工智能检测

如果您正确配置，诸如 linter 或电子邮件渲染验证器之类的 ai 工具可以检测未完成的元标记。

使用这些工具自动进行元标记检测并减少人为错误。

尝试一下！

记住：人工智能助手会犯很多错误

结论

不完整的元标记不仅仅是草率，而且是有害的。验证标签、断言完整性并在需要时引发异常。

仔细处理元标签可以防止错误并确保专业体验。

关系

更多信息

免责声明

代码味道是我的观点。

制作人员

托马斯·马丁内斯 (tomas martinez) 在 unsplash 上拍摄的照片

最好的错误消息是永远不会出现的错误消息。

托马斯·福克斯

本文是 codesmell 系列的一部分。