コードの匂い - DirName とファイル

パス変数のあいまいな名前を避ける

TL;DR: コードをよりよく理解するために明確な名前を使用してください。

問題点

• 変数の目的が不明瞭
• 全単射障害
• 誤解を招く文脈
• 繰り返しコード
• メンテナンスが難しくなる
• 可読性の低下
• 略語
• 認知負荷の増加

ソリューション

1. 単射に敬意を表します
2. 正確な名前を使用してください
3. 曖昧さを避ける
4. コンテキストを明確に保ちます
5. 再利用可能なコードを抽出
6. 命名規則に従います
7. ルールに従って名前を具体化します

コンテクスト

単一の fileName または directoryPath を処理する場合、file や dirName などのあいまいな名前は混乱を引き起こします。

• ファイルはファイル
を表す必要があります
• fileName はファイルの名前を表す必要があります
• fileContents はファイルのコンテンツを表す必要があります
• fileHandler は外部リソースへのポインタを表す必要があります
• dirName は directoryPath である必要があります

名前の fileName やディレクトリの directoryPath などの明確な名前は、各変数の役割を伝えます。

変数ファイルに名前を付けると、その目的について他の人が混乱する可能性があります。ファイル オブジェクトを保存しますか、それともファイル名だけを保存しますか?

変数に directoryName の代わりに dirName という名前を付けると、あいまいさが生じます。

明確で説明的な変数名により、特に共同作業環境でのコードの可読性と保守性が向上します。

サンプルコード

間違っている

右

検出

[X] 半自動

ファイルまたはディレクトリ パスを処理するコード内で、file や dirName などの一般的な名前を探します。

タグ

• 命名

レベル

[x] 初心者

AIの生成

AI モデルは、具体的な指示がなければ、file や dirName などのあいまいな名前をデフォルトで使用する場合があります。

わかりやすい名前付けとコード抽出ガイドラインを追加すると、AI の出力を改善できます。

AI検出

AI ツールは、明確な命名規則を使用し、冗長なコードを避けるためにプロンプ​​トが表示された場合はコードの抽出を提案することで、この問題を解決できます。

試してみてください!

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

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

結論

fileName や directoryPath などの正確な名前を使用し、再利用可能なメソッドを抽出することにより、コードの明確さと保守性が向上します。

これらの簡単な方法は、冗長性を減らし、コードを理解しやすくするのに役立ちます。

関係

コード スメル 33 - 略語

マキシ・コンティエリ ・ 2020年11月24日

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

免責事項

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

クレジット

Unsplash の Gabriel Heinzer による写真

---

コードは、まず人間が読み取れるように記述し、次にマシンが読み取れるように記述する必要があります。

ドン・ラーブス

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

Maxi Contieri ・ 2020年12月28日

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

---

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

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

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

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

以上がコードの匂い - DirName とファイルの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。