Bau Kod - Pisau Cukur Hanlon

Jangan Terlalu Rumit: Pastikan Ia Mudah

TL;DR: Kod overdefensive membawa kepada kerumitan yang tidak perlu.

Masalah

• Kerumitan yang tidak perlu

• Logik mengelirukan

• Pepijat tersembunyi

• Penyelenggaraan yang lebih keras

• Prestasi yang lebih perlahan

• Kod Berterabur

Penyelesaian

1. Memudahkan semakan

2. Percaya logik anda

3. Fokus pada perkara penting

4. Ikuti K.I.S.S. prinsip

5. Refactor selalu

Konteks

Terlalu berfikir dan mereka bentuk kod anda boleh membawa kepada kerumitan yang tidak perlu.

Anda mungkin perlu bertahan daripada setiap senario yang mungkin, tetapi pendekatan ini selalunya menghasilkan kod yang mengelirukan.

Hanlon's Razor mencadangkan agar anda tidak menganggap niat jahat apabila kesilapan mudah atau salah faham lebih berkemungkinan besar.

Elakkan pengaturcaraan yang terlalu defensif dan fokus pada logik yang jelas dan jelas.

Anda mungkin menjangkakan masalah masa depan yang mungkin tidak akan berlaku atau cuba menjadikan kod anda terlalu fleksibel.

Kod ringkas lebih mudah diselenggara, nyahpepijat dan difahami.

Kod Contoh

salah

function processData(data) {
    if (typeof data === 'undefined') {
        throw new Error('Data is undefined');
    }

    if (typeof data !== 'object') {
        throw new Error('Data is not an object');
    }

    if (data === null) {
        throw new Error('Data is null');
    }

    if (Array.isArray(data)) {
        throw new Error('Data should not be an array');
    }

    if (!data.hasOwnProperty('items')) {
        return [];
    }

    if (!Array.isArray(data.items)) {
        throw new Error('Items should be an array');
    }

    if (data.items.length === 0) {
        return []; 
    }

    let processedItems = [];
    for (let item of data.items) {
        if (typeof item === 'undefined') {
            continue; // Skip undefined items
        }

        if (typeof item !== 'object') {
            continue; // Skip non-object items
        }

        if (item === null) {
            continue; // Skip null items
        }

        processedItems.push(processItem(item));
    }

    return processedItems;
}

Betul

function processData(data) {
    if (!Array.isArray(data.items)) {
        throw new Error('Invalid data');
    }

    return data.items
        .filter(item => typeof item === 'object' && item !== null)
        .map(item => processItem(item));
}

Pengesanan

[X] Manual

Kod rumit biasanya mempunyai lebih banyak baris dan kaedah yang panjang adalah petunjuk yang mungkin.

Tag

• Bloaters

Tahap

[x] Pertengahan

Penjanaan AI

Penjana AI boleh memperkenalkan bau ini apabila mereka cuba mengambil kira setiap bekas tepi yang mungkin.

Sebagai contoh, berurusan dengan NULL adalah tidak perlu jika anda mengelakkannya sepenuhnya.

Pengesanan AI

Alat AI boleh membantu mengesan kod yang terlalu defensif dengan menganalisis logik dan mencadangkan pemudahan dengan bimbingan yang betul.

Alat ini selalunya mengesyorkan untuk mengalih keluar semakan yang tidak perlu atau menggabungkannya untuk kejelasan.

Kesimpulan

Elakkan terlalu memikirkan dan mereka bentuk kod anda secara berlebihan.

Fokus pada senario yang paling mungkin dan tulis logik yang jelas dan jelas.

Kesederhanaan membawa kepada kualiti kod yang lebih baik dan penyelenggaraan yang lebih mudah.

perhubungan

Bau Kod 149 - Rantaian Pilihan

Maxi Contieri ・ 16 Jul '22

#javascript #webdev #pemula #pengaturcaraan

Bau Kod 12 - Null

Maxi Contieri ・ 31 Okt '20

#codenewbie #tutorial #oop

Maklumat Lanjut

Wikipedia

Pengaturcaraan Defensif

Penafian

Bau Kod adalah pendapat saya.

Kredit

Foto oleh Nacho Fernández di Unsplash

---

Kesederhanaan ialah kecanggihan muktamad.

Leonardo da Vinci

Petikan Hebat Kejuruteraan Perisian

Maxi Contieri ・ 28 Dis '20

#codenewbie #pengaturcaraan #quotes #perisian

---

Artikel ini adalah sebahagian daripada Siri CodeSmell.

Cara Mencari Bahagian Busuk Kod anda

Maxi Contieri ・ 21 Mei '21

#codenewbie #tutorial #codequality #pemula

Atas ialah kandungan terperinci Bau Kod - Pisau Cukur Hanlon. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!