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!

Artikel Panas

<🎜>: Bubble Gum Simulator Infinity - Cara Mendapatkan dan Menggunakan Kekunci Diraja
3 minggu yang lalu By 尊渡假赌尊渡假赌尊渡假赌
Mandragora: Whispers of the Witch Tree - Cara Membuka Kunci Cangkuk Bergelut
3 minggu yang lalu By 尊渡假赌尊渡假赌尊渡假赌
Nordhold: Sistem Fusion, dijelaskan
3 minggu yang lalu By 尊渡假赌尊渡假赌尊渡假赌

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)

Topik panas

Tutorial Java
1667
14
Tutorial PHP
1273
29
Tutorial C#
1255
24
Enjin JavaScript: Membandingkan Pelaksanaan Enjin JavaScript: Membandingkan Pelaksanaan Apr 13, 2025 am 12:05 AM

Enjin JavaScript yang berbeza mempunyai kesan yang berbeza apabila menguraikan dan melaksanakan kod JavaScript, kerana prinsip pelaksanaan dan strategi pengoptimuman setiap enjin berbeza. 1. Analisis leksikal: Menukar kod sumber ke dalam unit leksikal. 2. Analisis Tatabahasa: Menjana pokok sintaks abstrak. 3. Pengoptimuman dan Penyusunan: Menjana kod mesin melalui pengkompil JIT. 4. Jalankan: Jalankan kod mesin. Enjin V8 mengoptimumkan melalui kompilasi segera dan kelas tersembunyi, Spidermonkey menggunakan sistem kesimpulan jenis, menghasilkan prestasi prestasi yang berbeza pada kod yang sama.

Python vs JavaScript: Keluk Pembelajaran dan Kemudahan Penggunaan Python vs JavaScript: Keluk Pembelajaran dan Kemudahan Penggunaan Apr 16, 2025 am 12:12 AM

Python lebih sesuai untuk pemula, dengan lengkung pembelajaran yang lancar dan sintaks ringkas; JavaScript sesuai untuk pembangunan front-end, dengan lengkung pembelajaran yang curam dan sintaks yang fleksibel. 1. Sintaks Python adalah intuitif dan sesuai untuk sains data dan pembangunan back-end. 2. JavaScript adalah fleksibel dan digunakan secara meluas dalam pengaturcaraan depan dan pelayan.

Dari C/C ke JavaScript: Bagaimana semuanya berfungsi Dari C/C ke JavaScript: Bagaimana semuanya berfungsi Apr 14, 2025 am 12:05 AM

Peralihan dari C/C ke JavaScript memerlukan menyesuaikan diri dengan menaip dinamik, pengumpulan sampah dan pengaturcaraan asynchronous. 1) C/C adalah bahasa yang ditaip secara statik yang memerlukan pengurusan memori manual, manakala JavaScript ditaip secara dinamik dan pengumpulan sampah diproses secara automatik. 2) C/C perlu dikumpulkan ke dalam kod mesin, manakala JavaScript adalah bahasa yang ditafsirkan. 3) JavaScript memperkenalkan konsep seperti penutupan, rantaian prototaip dan janji, yang meningkatkan keupayaan pengaturcaraan fleksibiliti dan asynchronous.

JavaScript dan Web: Fungsi teras dan kes penggunaan JavaScript dan Web: Fungsi teras dan kes penggunaan Apr 18, 2025 am 12:19 AM

Penggunaan utama JavaScript dalam pembangunan web termasuk interaksi klien, pengesahan bentuk dan komunikasi tak segerak. 1) kemas kini kandungan dinamik dan interaksi pengguna melalui operasi DOM; 2) pengesahan pelanggan dijalankan sebelum pengguna mengemukakan data untuk meningkatkan pengalaman pengguna; 3) Komunikasi yang tidak bersesuaian dengan pelayan dicapai melalui teknologi Ajax.

JavaScript in Action: Contoh dan projek dunia nyata JavaScript in Action: Contoh dan projek dunia nyata Apr 19, 2025 am 12:13 AM

Aplikasi JavaScript di dunia nyata termasuk pembangunan depan dan back-end. 1) Memaparkan aplikasi front-end dengan membina aplikasi senarai TODO, yang melibatkan operasi DOM dan pemprosesan acara. 2) Membina Restfulapi melalui Node.js dan menyatakan untuk menunjukkan aplikasi back-end.

Memahami Enjin JavaScript: Butiran Pelaksanaan Memahami Enjin JavaScript: Butiran Pelaksanaan Apr 17, 2025 am 12:05 AM

Memahami bagaimana enjin JavaScript berfungsi secara dalaman adalah penting kepada pemaju kerana ia membantu menulis kod yang lebih cekap dan memahami kesesakan prestasi dan strategi pengoptimuman. 1) aliran kerja enjin termasuk tiga peringkat: parsing, penyusun dan pelaksanaan; 2) Semasa proses pelaksanaan, enjin akan melakukan pengoptimuman dinamik, seperti cache dalam talian dan kelas tersembunyi; 3) Amalan terbaik termasuk mengelakkan pembolehubah global, mengoptimumkan gelung, menggunakan const dan membiarkan, dan mengelakkan penggunaan penutupan yang berlebihan.

Python vs JavaScript: Komuniti, Perpustakaan, dan Sumber Python vs JavaScript: Komuniti, Perpustakaan, dan Sumber Apr 15, 2025 am 12:16 AM

Python dan JavaScript mempunyai kelebihan dan kekurangan mereka sendiri dari segi komuniti, perpustakaan dan sumber. 1) Komuniti Python mesra dan sesuai untuk pemula, tetapi sumber pembangunan depan tidak kaya dengan JavaScript. 2) Python berkuasa dalam bidang sains data dan perpustakaan pembelajaran mesin, sementara JavaScript lebih baik dalam perpustakaan pembangunan dan kerangka pembangunan depan. 3) Kedua -duanya mempunyai sumber pembelajaran yang kaya, tetapi Python sesuai untuk memulakan dengan dokumen rasmi, sementara JavaScript lebih baik dengan MDNWebDocs. Pilihan harus berdasarkan keperluan projek dan kepentingan peribadi.

Python vs JavaScript: Persekitaran dan Alat Pembangunan Python vs JavaScript: Persekitaran dan Alat Pembangunan Apr 26, 2025 am 12:09 AM

Kedua -dua pilihan Python dan JavaScript dalam persekitaran pembangunan adalah penting. 1) Persekitaran pembangunan Python termasuk Pycharm, Jupyternotebook dan Anaconda, yang sesuai untuk sains data dan prototaip cepat. 2) Persekitaran pembangunan JavaScript termasuk node.js, vscode dan webpack, yang sesuai untuk pembangunan front-end dan back-end. Memilih alat yang betul mengikut keperluan projek dapat meningkatkan kecekapan pembangunan dan kadar kejayaan projek.

See all articles