パス変数のあいまいな名前を避ける
TL;DR: コードをよりよく理解するために明確な名前を使用してください。
問題点
- 変数の目的が不明瞭
- 全単射障害
- 誤解を招く文脈
- 繰り返しコード
- メンテナンスが難しくなる
- 可読性の低下
- 略語
- 認知負荷の増加
ソリューション
- 単射に敬意を表します
- 正確な名前を使用してください
- 曖昧さを避ける
- コンテキストを明確に保ちます
- 再利用可能なコードを抽出
- 命名規則に従います
- ルールに従って名前を具体化します
コンテクスト
単一の 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 サイトの他の関連記事を参照してください。
JavaScriptの役割：WebをインタラクティブでダイナミックにするApr 24, 2025 am 12:12 AMJavaScriptは、Webページのインタラクティブ性とダイナミズムを向上させるため、現代のWebサイトの中心にあります。 1）ページを更新せずにコンテンツを変更できます。2）Domapiを介してWebページを操作する、3）アニメーションやドラッグアンドドロップなどの複雑なインタラクティブ効果、4）ユーザーエクスペリエンスを改善するためのパフォーマンスとベストプラクティスを最適化します。
CおよびJavaScript：接続が説明しましたApr 23, 2025 am 12:07 AMCおよびJavaScriptは、WebAssemblyを介して相互運用性を実現します。 1）CコードはWebAssemblyモジュールにコンパイルされ、JavaScript環境に導入され、コンピューティングパワーが強化されます。 2）ゲーム開発では、Cは物理エンジンとグラフィックスレンダリングを処理し、JavaScriptはゲームロジックとユーザーインターフェイスを担当します。
Webサイトからアプリまで：JavaScriptの多様なアプリケーションApr 22, 2025 am 12:02 AMJavaScriptは、Webサイト、モバイルアプリケーション、デスクトップアプリケーション、サーバー側のプログラミングで広く使用されています。 1）Webサイト開発では、JavaScriptはHTMLおよびCSSと一緒にDOMを運用して、JQueryやReactなどのフレームワークをサポートします。 2）ReactNativeおよびIonicを通じて、JavaScriptはクロスプラットフォームモバイルアプリケーションを開発するために使用されます。 3）電子フレームワークにより、JavaScriptはデスクトップアプリケーションを構築できます。 4）node.jsを使用すると、JavaScriptがサーバー側で実行され、高い並行リクエストをサポートします。
Python vs. JavaScript：ユースケースとアプリケーションと比較されますApr 21, 2025 am 12:01 AMPythonはデータサイエンスと自動化により適していますが、JavaScriptはフロントエンドとフルスタックの開発により適しています。 1. Pythonは、データ処理とモデリングのためにNumpyやPandasなどのライブラリを使用して、データサイエンスと機械学習でうまく機能します。 2。Pythonは、自動化とスクリプトにおいて簡潔で効率的です。 3. JavaScriptはフロントエンド開発に不可欠であり、動的なWebページと単一ページアプリケーションの構築に使用されます。 4. JavaScriptは、node.jsを通じてバックエンド開発において役割を果たし、フルスタック開発をサポートします。
JavaScript通訳者とコンパイラにおけるC/Cの役割Apr 20, 2025 am 12:01 AMCとCは、主に通訳者とJITコンパイラを実装するために使用されるJavaScriptエンジンで重要な役割を果たします。 1）cは、JavaScriptソースコードを解析し、抽象的な構文ツリーを生成するために使用されます。 2）Cは、Bytecodeの生成と実行を担当します。 3）Cは、JITコンパイラを実装し、実行時にホットスポットコードを最適化およびコンパイルし、JavaScriptの実行効率を大幅に改善します。
JavaScript in Action：実際の例とプロジェクトApr 19, 2025 am 12:13 AM現実世界でのJavaScriptのアプリケーションには、フロントエンドとバックエンドの開発が含まれます。 1）DOM操作とイベント処理を含むTODOリストアプリケーションを構築して、フロントエンドアプリケーションを表示します。 2）node.jsを介してRestfulapiを構築し、バックエンドアプリケーションをデモンストレーションします。
JavaScriptとWeb：コア機能とユースケースApr 18, 2025 am 12:19 AMWeb開発におけるJavaScriptの主な用途には、クライアントの相互作用、フォーム検証、非同期通信が含まれます。 1）DOM操作による動的なコンテンツの更新とユーザーインタラクション。 2）ユーザーエクスペリエンスを改善するためにデータを提出する前に、クライアントの検証が実行されます。 3）サーバーとのリフレッシュレス通信は、AJAXテクノロジーを通じて達成されます。
JavaScriptエンジンの理解：実装の詳細Apr 17, 2025 am 12:05 AMJavaScriptエンジンが内部的にどのように機能するかを理解することは、開発者にとってより効率的なコードの作成とパフォーマンスのボトルネックと最適化戦略の理解に役立つためです。 1）エンジンのワークフローには、3つの段階が含まれます。解析、コンパイル、実行。 2）実行プロセス中、エンジンはインラインキャッシュや非表示クラスなどの動的最適化を実行します。 3）ベストプラクティスには、グローバル変数の避け、ループの最適化、constとletsの使用、閉鎖の過度の使用の回避が含まれます。
ホットAIツール
Undresser.AI Undress
リアルなヌード写真を作成する AI 搭載アプリ
AI Clothes Remover
写真から衣服を削除するオンライン AI ツール。
Undress AI Tool
脱衣画像を無料で
Clothoff.io
AI衣類リムーバー
Video Face Swap
完全無料の AI 顔交換ツールを使用して、あらゆるビデオの顔を簡単に交換できます。
人気の記事
ホットツール
MinGW - Minimalist GNU for Windows
このプロジェクトは osdn.net/projects/mingw に移行中です。引き続きそこでフォローしていただけます。 MinGW: GNU Compiler Collection (GCC) のネイティブ Windows ポートであり、ネイティブ Windows アプリケーションを構築するための自由に配布可能なインポート ライブラリとヘッダー ファイルであり、C99 機能をサポートする MSVC ランタイムの拡張機能が含まれています。すべての MinGW ソフトウェアは 64 ビット Windows プラットフォームで実行できます。
mPDF
mPDF は、UTF-8 でエンコードされた HTML から PDF ファイルを生成できる PHP ライブラリです。オリジナルの作者である Ian Back は、Web サイトから「オンザフライ」で PDF ファイルを出力し、さまざまな言語を処理するために mPDF を作成しました。 HTML2FPDF などのオリジナルのスクリプトよりも遅く、Unicode フォントを使用すると生成されるファイルが大きくなりますが、CSS スタイルなどをサポートし、多くの機能強化が施されています。 RTL (アラビア語とヘブライ語) や CJK (中国語、日本語、韓国語) を含むほぼすべての言語をサポートします。ネストされたブロックレベル要素 (P、DIV など) をサポートします。
Dreamweaver Mac版
ビジュアル Web 開発ツール
PhpStorm Mac バージョン
最新(2018.2.1)のプロフェッショナル向けPHP統合開発ツール
MantisBT
Mantis は、製品の欠陥追跡を支援するために設計された、導入が簡単な Web ベースの欠陥追跡ツールです。 PHP、MySQL、Web サーバーが必要です。デモおよびホスティング サービスをチェックしてください。
ホットトピック
7688
15163914139352128725122929