程式碼氣味 - 未解析的元標籤

不完整的元標籤是不專業的

TL;DR：不完整或空元標記會破壞功能和使用者體驗。

問題

• 標籤出現在輸出
• 電子郵件文字包含人類可讀文字之間的佔位符
• 遺失的佔位符會讓使用者感到困惑
• 網站呈現奇怪的字元
• 空值會觸發錯誤
• 潛在的安全注入漏洞

解決方案

1. 驗證元標記
2. 儘早斷言完整性
3. 快速失敗
4. 避免空值
5. 拋出有意義的異常
6. 自動元驗證

情境

當您留下未完成的元標記（例如 {user_name} 或 {product_name}）時，它們通常會潛入您的最終輸出中。想像一下發送一封電子郵件，內容是：「您好 {user_name}，您的 {product_name} 訂單已準備就緒。」

它讓人尖叫不專業並且讓使用者感到困惑。

空值會導致崩潰或靜默故障，從而導致糟糕的用戶體驗或進程中斷，從而使情況變得更糟。

您可以透過在渲染或發送之前斷言完整性來避免這種情況。

當您的程式碼發現不完整的元標記或空值時，立即停止進程並拋出異常。

範例程式碼

錯誤的

正確的

偵測

[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 ＃教程 #程式碼品質 #初學者

以上是程式碼氣味 - 未解析的元標籤的詳細內容。更多資訊請關注PHP中文網其他相關文章！