Bau Kod - Kekeliruan Linguistik-javaTutorial-php.cn

Bau Kod - Kekeliruan Linguistik

王林

Lepaskan： 2024-08-23 18:01:32

asal

1096 orang telah melayarinya

Penamaan Terlalu Rumit Membawa kepada Huru-hara

TL;DR: Penamaan itu sukar, jangan jadikan ia lebih sukar dengan kerumitan tidak sengaja yang tidak perlu.

Masalah

Nama yang tidak jelas, mengelirukan, samar-samar dan samar-samar
Istilah yang berlebihan
Abstraksi yang mengelirukan
Singkatan samar

Penyelesaian

Ringkaskan konvensyen penamaan
Pastikan konsisten
Elakkan jargon yang tidak perlu
Gunakan nama deskriptif berdasarkan tingkah laku
Kekalkan istilah yang konsisten

Konteks

Ludwig Wittgenstein berhujah bahawa banyak kekeliruan timbul daripada penyalahgunaan bahasa.

Ini berlaku apabila anda terlalu merumitkan nama, mencampurkan metafora atau menggunakan istilah yang tidak konsisten.

Apabila anda menamakan kelas, kaedah atau pembolehubah tanpa kejelasan, anda mencipta labirin linguistik yang sukar dilayari oleh orang lain.

Ini menyebabkan pepijat, menjadikan penyelenggaraan lebih sukar dan membawa kepada kekecewaan pasukan.

Kod Contoh

salah

public class AbstractDataHandlerManager {
    private String dtStr;

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

Salin selepas log masuk

Betul

public class SETIProcessor {

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

Salin selepas log masuk

Pengesanan

[X] Manual

Anda boleh mengesan bau ini apabila nama mula menjadi panjang, atau apabila anda melihat "Abstrak", "Pengurus," "Pengendali," "Pembantu" atau "Data" terlalu kerap.

Tanda lain ialah apabila anda mesti menerangkan maksud nama kepada pembangun lain contohnya dalam semakan kod.

Tahap

[X] Pemula

Penjanaan AI

Penjana AI sering mencipta bau ini dengan menghasilkan nama bertele-tele dan generik yang cuba merangkumi setiap konteks yang mungkin.

Mereka pakar dalam banyak domain dan menulis kod, tetapi selalunya mereka tidak melakukan kedua-duanya sekali melainkan diarahkan.

Pengesanan AI

Penjana AI kadangkala boleh membetulkan bau ini dengan arahan pemfaktoran semula mudah seperti "permudahkan nama" atau "alih keluar istilah berlebihan", tetapi bergelut dengan pemahaman kontekstual yang lebih mendalam.