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

wufei123 2025-01-05 阅读:60 评论:0
不完整的元标签是不专业的 tl;dr:不完整或空元标记会破坏功能和用户体验。 问题 标签出现在输出中 电子邮件文本包含人类可读文本之间的占位符 丢失的占位符会让用户感到困惑 网站呈现奇怪的字符 空值会触发错...

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

tl;dr:不完整或空元标记会破坏功能和用户体验。
问题
  • 标签出现在输出中
  • 电子邮件文本包含人类可读文本之间的占位符
  • 丢失的占位符会让用户感到困惑
  • 网站呈现奇怪的字符
  • 空值会触发错误
  • 潜在的安全注入漏洞
解决方案
  1. 验证元标记
  2. 尽早断言完整性
  3. 快速失败
  4. 避免空值
  5. 抛出有意义的异常
  6. 自动元验证
语境

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

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

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

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

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

示例代码 错误的
PHP
<?php

$emailbody = "hello {user_name}, 
your order for {product_name} is confirmed.";

// you forget to make the replacements
sendemail($emailbody);
正确的
PHP
<?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 工具可以检测未完成的元标记。

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

尝试一下!

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

without proper instructions with specific instructions chatgpt chatgpt claude claude perplexity perplexity copilot copilot gemini gemini 结论

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

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

关系 代码气味 - 未解析的元标签 代码气味 12 - 空 马克西·孔蒂耶里 ・2020 年 10 月 31 日 #codenewbie #教程 #哎呀 代码气味 - 未解析的元标签 code smell 139 - 用户界面中的业务代码 马克西·孔蒂耶里 ・22 年 6 月 9 日 #哎呀 #webdev #javascript #初学者 代码气味 - 未解析的元标签 code smell 97 - 没有同理心的错误消息 马克西·孔蒂耶里 ・2021 年 10 月 27 日 #开源 #ux #编程 #javascript 更多信息 代码气味 - 未解析的元标签 快速失败 马克西·孔蒂耶里 ・2020 年 12 月 6 日 #codenewbie #编程 #webdev #哎呀 代码气味 - 未解析的元标签 空:十亿美元的错误 马克西·孔蒂耶里 ・ 十一月 18 '20 #codenewbie #教程 #编程 #webdev 免责声明

代码味道是我的观点。

制作人员

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

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

托马斯·福克斯

代码气味 - 未解析的元标签 软件工程精彩名言 马克西·孔蒂耶里 ・ 2020 年 12 月 28 日 #codenewbie #编程 #引号 #软件

本文是 codesmell 系列的一部分。

代码气味 - 未解析的元标签 如何查找代码中的臭部分 马克西·孔蒂耶里 ・ 21 年 5 月 21 日 #codenewbie #教程 #代码质量 #初学者

以上就是代码气味 - 未解析的元标签的详细内容,更多请关注知识资源分享宝库其它相关文章!

版权声明

本站内容来源于互联网搬运,
仅限用于小范围内传播学习,请在下载后24小时内删除,
如果有侵权内容、不妥之处,请第一时间联系我们删除。敬请谅解!
E-mail:dpw1001@163.com

分享:

扫一扫在手机阅读、分享本文

发表评论
热门文章
  • BioWare埃德蒙顿工作室面临关闭危机,龙腾世纪制作总监辞职引关注(龙腾.总监.辞职.危机.面临.....)

    BioWare埃德蒙顿工作室面临关闭危机,龙腾世纪制作总监辞职引关注(龙腾.总监.辞职.危机.面临.....)
    知名变性人制作总监corrine busche离职bioware,引发业界震荡!外媒“smash jt”独家报道称,《龙腾世纪:影幢守护者》制作总监corrine busche已离开bioware,此举不仅引发了关于个人职业发展方向的讨论,更因其可能预示着bioware埃德蒙顿工作室即将关闭而备受关注。本文将深入分析busche离职的原因及其对bioware及游戏行业的影响。 Busche的告别信:挑战与感激并存 据“Smash JT”获得的内部邮件显示,Busche离职原...
  • boss直聘怎么取消面试预约 boss直聘上面试爽约了会怎么样(面试.爽约.预约.取消.boss.....)

    boss直聘怎么取消面试预约 boss直聘上面试爽约了会怎么样(面试.爽约.预约.取消.boss.....)
    求职宝典:boss直聘面试技巧及取消预约方法 各位求职者注意啦!在Boss直聘上,随意取消面试预约会留下爽约记录,影响后续求职!本文将指导您如何避免爽约,以及如何取消已预约的面试。 如何取消Boss直聘面试预约? 打开Boss直聘APP,进入“我的”页面。 点击“待面试”,查看面试日程。 选择需要取消的面试,点击“取消面试”按钮即可。 Boss直聘面试爽约的后果? 爽约行为会在HR端留下记录,影响您的求职成功率。其他HR也能看到您的不良记录,所以务必重视面试预约。...
  • 闪耀暖暖靡城永恒怎么样-闪耀暖暖靡城永恒套装介绍(闪耀.暖暖.套装.介绍.....)

    闪耀暖暖靡城永恒怎么样-闪耀暖暖靡城永恒套装介绍(闪耀.暖暖.套装.介绍.....)
    闪耀暖暖钻石竞技场第十七赛季“华梦泡影”即将开启!全新闪耀性感套装【靡城永恒】震撼来袭!想知道如何获得这套精美套装吗?快来看看吧! 【靡城永恒】套装设计理念抢先看: 设计灵感源于夜色中的孤星,象征着淡然、漠视一切的灰色瞳眸。设计师希望通过这套服装,展现出在虚幻与真实交织的夜幕下,一种独特的魅力。 服装细节考究,从面料的光泽、鞋跟声响到裙摆的弧度,都力求完美还原设计初衷。 【靡城永恒】套装设计亮点: 闪耀的绸缎与金丝交织,轻盈的羽毛增添华贵感。 这套服装仿佛是从无尽的黑...
  • 蛋仔派对2025最新皮肤兑换码汇总 最新皮肤兑换码一览(兑换.皮肤.最新.派对.汇总.....)

    蛋仔派对2025最新皮肤兑换码汇总 最新皮肤兑换码一览(兑换.皮肤.最新.派对.汇总.....)
    蛋仔派对2025最新皮肤兑换码大放送!游戏内新增多款皮肤兑换码,包含最新、福利和通用三种类型,助你轻松获取精美奖励! 赶紧来看看如何兑换吧! 兑换码列表: 最新兑换码: ccewndj4k4k、cdkqdfm4fh、peetnmp4ef、cdxymk8f67 福利兑换码: cca863ywtfa、eggy2310am、eggy2311gz、eggyeggy9wz 通用兑换码: pec74dkcty、jsrqkrrjmh、cd3wt7wrph、ccepn7d8cjf...
  • python怎么调用其他文件函数

    python怎么调用其他文件函数
    在 python 中调用其他文件中的函数,有两种方式:1. 使用 import 语句导入模块,然后调用 [模块名].[函数名]();2. 使用 from ... import 语句从模块导入特定函数,然后调用 [函数名]()。 如何在 Python 中调用其他文件中的函数 在 Python 中,您可以通过以下两种方式调用其他文件中的函数: 1. 使用 import 语句 优点:简单且易于使用。 缺点:会将整个模块导入到当前作用域中,可能会导致命名空间混乱。 步骤:...