コードの匂い - 未解決のメタタグ

不完全なメタタグはプロフェッショナルではありません

TL;DR: メタ タグが不完全または null であると、機能とユーザー エクスペリエンスが損なわれます。

問題点

• 出力にタグが表示されます
• 電子メールのテキストには、人間が判読できるテキストの間にプレースホルダーが含まれています
• プレースホルダーの欠落によりユーザーが混乱する
• Web サイトが奇妙な文字で表示される
• Null 値はエラーをトリガーします
• セキュリティインジェクションの潜在的な脆弱性

ソリューション

1. メタタグを検証する
2. 完全性を早期に主張する
3. 早く失敗してください
4. null 値を避ける
5. 意味のある例外をスローする
6. メタ検証を自動化する

コンテクスト

{user_name} や {product_name} などのメタ タグを未完成のままにすると、最終出力に紛れ込むことがよくあります。 「こんにちは、{user_name} 様。{product_name} のご注文の準備ができました。」というメールを送信することを想像してください。

専門的でないことを叫び、ユーザーを混乱させます。

Null 値は、クラッシュやサイレントエラーを引き起こし、ユーザーエクスペリエンスの低下やプロセスの破損につながるため、事態を悪化させます。

これは、レンダリングまたは送信する前に完全性を主張することで回避できます。

コードで不完全なメタ タグまたは null 値が見つかった場合は、プロセスを直ちに停止し、例外をスローします。

サンプルコード

間違っている

<?php

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

// You forget to make the replacements
sendEmail($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] 初心者

全単射が重要な理由

ユーザー データをプレースホルダーで表す場合、システムは 1 対 1 のマッピングを維持する必要があります。

{user_name} プレースホルダーは存在するが、対応する実際の名前が欠落している場合、このマッピングは壊れます。

これにより、エラー、混乱が発生し、アプリケーションの信頼が失われます。

全単射のコンプライアンスを確保すると、これらの問題を回避できます。

AIの生成

AI ツールは、プレースホルダーを使用してテンプレートを生成するときにこの臭いを引き起こすことがありますが、実際のデータを置き換えることはできません。

出力を使用する前に、すべてのプレースホルダーを検証して完了する必要があります。

AI検出

リンターや電子メール レンダリング バリデータなどの AI ツールは、正しく設定されていれば未完成のメタ タグを検出できます。

これらのツールを使用してメタタグ検出を自動化し、人的エラーを削減します。

試してみてください!

覚えておいてください: AI アシスタントは多くの間違いを犯します

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

結論

不完全なメタタグは、単にいい加減なだけではなく、有害です。タグを検証し、完全性をアサートし、必要に応じて例外をスローします。

メタ タグを慎重に処理することでエラーが防止され、プロフェッショナルなエクスペリエンスが保証されます。

関係

コードの匂い 12 - ヌル

マキシ・コンティエリ ・ 2020年10月31日

#コード初心者 ＃チュートリアル #おっと

コードの匂い 139 - ユーザー インターフェイスのビジネス コード

Maxi Contieri ・ 6月 9 '22

#おっと #webdev #javascript #初心者

コードの匂い 97 - 共感のないエラー メッセージ

マキシ・コンティエリ ・ 2021年10月27日

#オープンソース #ux ＃プログラミング #javascript

詳細情報

早く失敗してください

Maxi Contieri ・ 2020年12月6日

#コード初心者 ＃プログラミング #webdev #おっと

ヌル: 10 億ドルの間違い

Maxi Contieri ・ 2020年11月18日

#コード初心者 ＃チュートリアル ＃プログラミング #webdev

免責事項

コードの匂いは私の意見です。

クレジット

Unsplash の Tomas Martinez による写真

---

最良のエラー メッセージは、決して表示されないものです。

トーマス・フックス

ソフトウェア エンジニアリングの素晴らしい名言

Maxi Contieri ・ 2020年12月28日

#コード初心者 ＃プログラミング #引用符 ＃ソフトウェア

---

この記事は CodeSmell シリーズの一部です。

コードの怪しい部分を見つける方法

マキシ・コンティエリ・21年5月21日

#コード初心者 ＃チュートリアル #コード品質 #初心者

以上がコードの匂い - 未解決のメタタグの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。