複雑すぎる名前付けは混乱を招く

TL;DR: 名前を付けるのは難しいです。不必要に複雑にして難しくしないでください。

問題点

• 不明瞭、誤解を招く、漠然とした曖昧な名前

• 冗長な用語

• 紛らわしい抽象化

• 難解な略語

ソリューション

1. 命名規則を簡素化する

2. 一貫性を確保

3. 不必要な専門用語を避ける

4. 動作に基づいてわかりやすい名前を使用する

5. 一貫した用語を維持する

コンテクスト

ルートヴィヒ・ウィトゲンシュタインは、多くの混乱は言語の誤用から生じると主張しました。

これは、名前を複雑にしすぎたり、比喩を混ぜたり、一貫性のない用語を使用したりするときに発生します。

クラス、メソッド、または変数に明確に名前を付けると、他の人がナビゲートするのに苦労する言語迷路が作成されます。

これによりバグが発生し、メンテナンスが困難になり、チームのフラストレーションにつながります。

サンプルコード

間違っている

public class AbstractDataHandlerManager {
    private String dtStr;

    public void execProcessingOps(String input) {
        if (dtStr != null && !dtStr.isEmpty()) {
            // process
        }
    }
}

右

public class SETIProcessor {

    public void processSignal(String input) {      
            // process
        }
    }
}

検出

[X] マニュアル

名前が長くなり始めた場合、または「Abstract」、「Manager」、「Handler」、「Helper」、または「Data」が頻繁に表示される場合に、この臭いを検出できます。

もう 1 つの兆候は、コード レビューなどで名前の意味を他の開発者に説明しなければならない場合です。

タグ

• ネーミング

レベル

[X] 初心者

AIの生成

AI ジェネレーターは、考えられるすべてのコンテキストをカバーしようとする冗長で一般的な名前を生成することによって、この匂いを作成することがよくあります。

彼らは多くの分野の専門家であり、コードを作成しますが、指示がない限り、両方を同時に行うことはよくありません。

AI検出

AI ジェネレーターは、「名前を単純化する」や「冗長な用語を削除する」などの単純なリファクタリング命令でこの問題を解決できる場合がありますが、より深い文脈の理解には苦労します。

結論

コード内の言語上の混乱は、不必要な複雑さにつながります。

コードを読みやすく、保守しやすくするために、明確で一貫性のあるわかりやすい名前を使用します。

関係

コード スメル 22 - ヘルパー

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

#おっと #ヘルパー #コード初心者 #初心者

コードの匂い 38 - 抽象的な名前

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

#おっと #コード初心者 ＃ネーミング #webdev

コードの匂い 197 - 無償のコンテキスト

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

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

コード スメル 113 - データのネーミング

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

#おっと #webdev #データベース #リファクタリング

詳細情報

ウィトゲンシュタインの言語混乱の概念

ソフトウェアは何ですか

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

#おっと ＃固体 #初心者 ＃デザイン

名前とは何ですか? — パート I: クエスト

マキシ・コンティエリ ・ 2021年2月9日

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

名前とは何ですか - パート II リハビリ

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

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

免責事項

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

クレジット

Unsplash の Mimi Tian による写真

明確な言葉の最大の敵は不誠実です。

ジョージ・オーウェル

ソフトウェア エンジニアリングの名言

マキシ・コンティエリ ・ 2020年12月28日

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

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

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

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

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