Rumah hujung hadapan web tutorial js Apakah yang saya faham tentang Kod Bersih?

Apakah yang saya faham tentang Kod Bersih?

Jan 20, 2025 am 02:41 AM

Menyelami Amalan Terbaik Pembangunan Perisian: Refleksi tentang Kod Bersih

Apabila memulakan pengajian dalam amalan pembangunan perisian yang baik, saya membayangkan "Kod Bersih" (Kod Bersih) sebagai satu set peraturan mudah untuk memastikan kod boleh dibaca. Sebahagiannya, persepsi ini betul. Walau bagaimanapun, peraturan ini tidak selalu digunakan untuk semua jenis kod dan pastinya tidak difahami sepenuhnya hanya dengan membaca buku.

O que eu entendo sobre Clean Code?

Kod Bersih: Perjalanan Berterusan

Baru-baru ini, saya membaca semula Kod Bersih klasik, oleh Robert C. Martin, dan pemahaman saya sangat berbeza daripada bacaan pertama, enam tahun lalu. Sebagai pelajar kolej pada masa itu, banyak masalah dan penyelesaian yang dikemukakan tidak sepenuhnya jelas. Ini adalah salah tanggapan besar: Kod Bersih bukan untuk pemula.

"...bagaimana jika anda seorang doktor dan pesakit meminta anda menghentikan semua mencuci tangan sebagai persediaan untuk pembedahan hanya kerana ia mengambil masa terlalu lama? [...] adalah tidak profesional untuk pengaturcara untuk menyerah kepada kehendak pengurus hebat yang tidak memahami risiko menjana kod yang mengelirukan."

Artikel ini menyerlahkan perkara yang berkaitan daripada pembacaan saya dan berkongsi pengalaman praktikal.

Fungsi: Tanggungjawab Tunggal

Fungsi yang ditulis dengan baik harus mempunyai satu tanggungjawab: lakukan satu perkara, lakukan dengan baik, dan hanya itu sahaja. Mengumpulkan pelbagai tanggungjawab ke dalam satu peranan menjadikan kod sukar dibaca, diuji dan dikekalkan.

Contoh peranan dengan pelbagai tanggungjawab (menyelamatkan dan memberitahu pengguna):

<code>function salvarUsuarioENotificar(usuario) {
    // Valida os dados do usuário
    if (!usuario.nome || !usuario.email) {
        throw new Error('Dados do usuário incompletos.')
    }

    // Salva no banco de dados
    bancoDeDados.salvar(usuario)

    // Envia um e-mail de boas-vindas
    emailService.enviarEmail(usuario.email, 'Bem-vindo!', 'Obrigado por se cadastrar!')
}</code>
Salin selepas log masuk
Salin selepas log masuk

Selepas pemfaktoran semula, setiap tanggungjawab dalam peranan tertentu:

<code>function validarUsuario(usuario) {
    if (!usuario.nome || !usuario.email) {
        throw new Error('Dados do usuário incompletos.')
    }
}

function salvarUsuario(usuario) {
    bancoDeDados.salvar(usuario)
}

function enviarEmailDeBoasVindas(usuario) {
    emailService.enviarEmail(usuario.email, 'Bem-vindo!', 'Obrigado por se cadastrar!')
}

function processarCadastroDeUsuario(usuario) {
    validarUsuario(usuario)
    salvarUsuario(usuario)
    enviarEmailDeBoasVindas(usuario)
}</code>
Salin selepas log masuk
Salin selepas log masuk

Kini setiap fungsi mempunyai satu tanggungjawab, menjadikan kod lebih mudah dibaca dan lebih mudah diselenggara.

Komen: Utamakan Nama Yang Jelas Sendiri

Komen berguna, tetapi utamakan nama yang menerangkan sendiri untuk mengelakkan lebihan. Komen yang jelas mencemarkan kod.

Contoh ulasan yang tidak perlu:

<code>/** Dia do mês **/
private number diaDoMes;</code>
Salin selepas log masuk

Meningkatkan dengan nama yang lebih jelas dan tiada ulasan:

<code>private number diaDoMesAtual;</code>
Salin selepas log masuk

Objek dan Struktur Data: Enkapsulasi dan Kejelasan

Reka bentuk berorientasikan objek yang baik memfokuskan pada mendedahkan operasi dan menyembunyikan butiran pelaksanaan. Ini menggalakkan enkapsulasi, mengurangkan gandingan dan memudahkan penyelenggaraan.

Contoh enkapsulasi dalam kelas Circulo:

<code>class Circulo implements Forma {
    private Ponto centro;
    private number raio;
    private number PI = 3.14159;

    public number calcularArea() {
        return PI * raio * raio;
    }
}</code>
Salin selepas log masuk

Elakkan menggunakan semula pembolehubah dalam skop yang berbeza untuk tujuan yang berbeza. Gunakan pembolehubah yang berbeza untuk lebih jelas.

Pengendalian Ralat: Pengecualian Daripada Berbilang Pemeriksaan

Pada masa lalu, pengendalian ralat adalah terhad. Hari ini, penggunaan pengecualian menjadikan kod lebih bersih dan lebih mudah dibaca.

Contoh kod verbose dengan berbilang pengesahan:

<code>function salvarUsuarioENotificar(usuario) {
    // Valida os dados do usuário
    if (!usuario.nome || !usuario.email) {
        throw new Error('Dados do usuário incompletos.')
    }

    // Salva no banco de dados
    bancoDeDados.salvar(usuario)

    // Envia um e-mail de boas-vindas
    emailService.enviarEmail(usuario.email, 'Bem-vindo!', 'Obrigado por se cadastrar!')
}</code>
Salin selepas log masuk
Salin selepas log masuk

Memfaktorkan semula menggunakan pengecualian:

<code>function validarUsuario(usuario) {
    if (!usuario.nome || !usuario.email) {
        throw new Error('Dados do usuário incompletos.')
    }
}

function salvarUsuario(usuario) {
    bancoDeDados.salvar(usuario)
}

function enviarEmailDeBoasVindas(usuario) {
    emailService.enviarEmail(usuario.email, 'Bem-vindo!', 'Obrigado por se cadastrar!')
}

function processarCadastroDeUsuario(usuario) {
    validarUsuario(usuario)
    salvarUsuario(usuario)
    enviarEmailDeBoasVindas(usuario)
}</code>
Salin selepas log masuk
Salin selepas log masuk

Ujian Unit: Kejelasan dan Fokus

Ujian bersih mestilah jelas, mudah dan konsisten. Sampaikan banyak maklumat dengan sedikit ungkapan.

Struktur am ujian: Bina, Kendalikan, Sahkan.

Kelas: SRP (Prinsip Tanggungjawab Tunggal)

Nama kelas harus mencerminkan tanggungjawabnya. Kelas hendaklah kecil, dengan satu tujuan. SRP memastikan setiap kelas hanya mempunyai satu tanggungjawab.

Kesimpulan: Kod Bersih ialah Perjalanan

Kod Bersih tidak boleh dipelajari sekaligus. Ia adalah perjalanan berterusan yang memerlukan latihan, refleksi dan evolusi. Kemahiran sebenar datang dengan pengalaman dan keupayaan untuk melihat peningkatan. Peraturan Kent Beck (menguji, mengelakkan pertindihan, kejelasan, meminimumkan kelas dan kaedah) ialah panduan yang berharga.

Atas ialah kandungan terperinci Apakah yang saya faham tentang Kod Bersih?. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!

Kenyataan Laman Web ini
Kandungan artikel ini disumbangkan secara sukarela oleh netizen, dan hak cipta adalah milik pengarang asal. Laman web ini tidak memikul tanggungjawab undang-undang yang sepadan. Jika anda menemui sebarang kandungan yang disyaki plagiarisme atau pelanggaran, sila hubungi admin@php.cn

Alat AI Hot

Undresser.AI Undress

Undresser.AI Undress

Apl berkuasa AI untuk mencipta foto bogel yang realistik

AI Clothes Remover

AI Clothes Remover

Alat AI dalam talian untuk mengeluarkan pakaian daripada foto.

Undress AI Tool

Undress AI Tool

Gambar buka pakaian secara percuma

Clothoff.io

Clothoff.io

Penyingkiran pakaian AI

Video Face Swap

Video Face Swap

Tukar muka dalam mana-mana video dengan mudah menggunakan alat tukar muka AI percuma kami!

Alat panas

Notepad++7.3.1

Notepad++7.3.1

Editor kod yang mudah digunakan dan percuma

SublimeText3 versi Cina

SublimeText3 versi Cina

Versi Cina, sangat mudah digunakan

Hantar Studio 13.0.1

Hantar Studio 13.0.1

Persekitaran pembangunan bersepadu PHP yang berkuasa

Dreamweaver CS6

Dreamweaver CS6

Alat pembangunan web visual

SublimeText3 versi Mac

SublimeText3 versi Mac

Perisian penyuntingan kod peringkat Tuhan (SublimeText3)

Apa yang perlu saya lakukan jika saya menghadapi percetakan kod yang dihiasi untuk resit kertas terma depan? Apa yang perlu saya lakukan jika saya menghadapi percetakan kod yang dihiasi untuk resit kertas terma depan? Apr 04, 2025 pm 02:42 PM

Soalan dan penyelesaian yang sering ditanya untuk percetakan tiket kertas terma depan dalam pembangunan front-end, percetakan tiket adalah keperluan umum. Walau bagaimanapun, banyak pemaju sedang melaksanakan ...

Demystifying JavaScript: Apa yang berlaku dan mengapa penting Demystifying JavaScript: Apa yang berlaku dan mengapa penting Apr 09, 2025 am 12:07 AM

JavaScript adalah asas kepada pembangunan web moden, dan fungsi utamanya termasuk pengaturcaraan yang didorong oleh peristiwa, penjanaan kandungan dinamik dan pengaturcaraan tak segerak. 1) Pengaturcaraan yang didorong oleh peristiwa membolehkan laman web berubah secara dinamik mengikut operasi pengguna. 2) Penjanaan kandungan dinamik membolehkan kandungan halaman diselaraskan mengikut syarat. 3) Pengaturcaraan Asynchronous memastikan bahawa antara muka pengguna tidak disekat. JavaScript digunakan secara meluas dalam interaksi web, aplikasi satu halaman dan pembangunan sisi pelayan, sangat meningkatkan fleksibiliti pengalaman pengguna dan pembangunan silang platform.

Siapa yang dibayar lebih banyak Python atau JavaScript? Siapa yang dibayar lebih banyak Python atau JavaScript? Apr 04, 2025 am 12:09 AM

Tidak ada gaji mutlak untuk pemaju Python dan JavaScript, bergantung kepada kemahiran dan keperluan industri. 1. Python boleh dibayar lebih banyak dalam sains data dan pembelajaran mesin. 2. JavaScript mempunyai permintaan yang besar dalam perkembangan depan dan stack penuh, dan gajinya juga cukup besar. 3. Faktor mempengaruhi termasuk pengalaman, lokasi geografi, saiz syarikat dan kemahiran khusus.

Bagaimana untuk mencapai kesan menatal paralaks dan kesan animasi elemen, seperti laman web rasmi Shiseido?
atau:
Bagaimanakah kita dapat mencapai kesan animasi yang disertai dengan menatal halaman seperti laman web rasmi Shiseido? Bagaimana untuk mencapai kesan menatal paralaks dan kesan animasi elemen, seperti laman web rasmi Shiseido? atau: Bagaimanakah kita dapat mencapai kesan animasi yang disertai dengan menatal halaman seperti laman web rasmi Shiseido? Apr 04, 2025 pm 05:36 PM

Perbincangan mengenai realisasi kesan animasi tatal dan elemen Parallax dalam artikel ini akan meneroka bagaimana untuk mencapai yang serupa dengan laman web rasmi Shiseido (https://www.shiseido.co.jp/sb/wonderland/) ... ...

Adakah JavaScript sukar belajar? Adakah JavaScript sukar belajar? Apr 03, 2025 am 12:20 AM

Pembelajaran JavaScript tidak sukar, tetapi ia mencabar. 1) Memahami konsep asas seperti pembolehubah, jenis data, fungsi, dan sebagainya. 2) Pengaturcaraan asynchronous tuan dan melaksanakannya melalui gelung acara. 3) Gunakan operasi DOM dan berjanji untuk mengendalikan permintaan tak segerak. 4) Elakkan kesilapan biasa dan gunakan teknik debugging. 5) Mengoptimumkan prestasi dan mengikuti amalan terbaik.

Evolusi JavaScript: Trend Semasa dan Prospek Masa Depan Evolusi JavaScript: Trend Semasa dan Prospek Masa Depan Apr 10, 2025 am 09:33 AM

Trend terkini dalam JavaScript termasuk kebangkitan TypeScript, populariti kerangka dan perpustakaan moden, dan penerapan webassembly. Prospek masa depan meliputi sistem jenis yang lebih berkuasa, pembangunan JavaScript, pengembangan kecerdasan buatan dan pembelajaran mesin, dan potensi pengkomputeran IoT dan kelebihan.

Bagaimana untuk menggabungkan elemen array dengan ID yang sama ke dalam satu objek menggunakan JavaScript? Bagaimana untuk menggabungkan elemen array dengan ID yang sama ke dalam satu objek menggunakan JavaScript? Apr 04, 2025 pm 05:09 PM

Bagaimana cara menggabungkan elemen array dengan ID yang sama ke dalam satu objek dalam JavaScript? Semasa memproses data, kita sering menghadapi keperluan untuk mempunyai id yang sama ...

Operasi Asynchronous Zustand: Bagaimana untuk memastikan keadaan terkini yang diperoleh oleh Usestore? Operasi Asynchronous Zustand: Bagaimana untuk memastikan keadaan terkini yang diperoleh oleh Usestore? Apr 04, 2025 pm 02:09 PM

Masalah kemas kini data dalam operasi Zustand Asynchronous. Apabila menggunakan Perpustakaan Pengurusan Negeri Zustand, anda sering menghadapi masalah kemas kini data yang menyebabkan operasi tak segerak menjadi tidak lama lagi. � ...

See all articles