Students Save 30%! Learn & create with unlimited courses & creative assets Students Save 30%! Save Now
Advertisement
  1. Code
  2. HTML & CSS
Code

15 Latihan Terbaik untuk Menulis Kod yang Sangat Mudah Dibaca

by
Difficulty:IntermediateLength:LongLanguages:

Malay (Melayu) translation by Uwais Al Qarni (you can also view the original English article)

Dua kali dalam sebulan, kami meninjau kembali beberapa pilihan posting para pembaca dari riwayat Nettuts+.

Kod Keterbacaan merupakan topik universal di dunia pemrograman komputer.  Ini adalah salah satu hal yang perlu kita pelajari sebagai pengembang.  Artikel ini akan memberikan terperinci 15 best practices apabila ingin menulis kod yang mudah dibaca.


1- Mengomentari & Mendokumentasi

IDE (Persekitaran Pembangunan Bersepadu) telah berkembang jauh dalam beberapa tahun terakhir.  Ini membuat komen pada kod anda lebih berguna daripada sebelumnya.  Standard tertentu dalam komentar anda membolehkan IDE dan alat lain untuk memanfaatkannya dalam hal yang berbeda.

Perhatikan contoh ini:

Komentar yang saya tambah pada fungsi boleh dipaparkan setiap kali saya menggunakan fungsi itu, bahkan pada file yang berbeda.

Ini adalah contoh lain di mana saya memanggil fungsi dari perpustakaan pihak ketiga:

Dalam contoh tertentu, jenis komentar (atau dokumentasi) yang digunakan adalah asas dari PHPDoc , dan IDE seperti Aptana .


2- Indentasi Yang Konsisten

Saya anggap anda sudah tahu bahawa anda harus memberikan indentasi pada kode anda.  Namun, itu juga perlu diperhatikan apa itu adalah ide yang baik untuk tetap memakai indentasi yang konsisten.

Ada lebih dari satu cara dalam mengindentasi kod.

Gaya 1:
Gaya 2:
Gaya 3:

Saya menggunakan gaya ke-2 pada kod saya tapi kadang-kadang berubah menjadi yang ke-1  Tapi itu hanya masalah preferensi.  Tidak ada namanya gaya "terbaik" yang harus semua orang ikuti.  Sebenarnya, gaya terbaik, adalah gaya yang konsisten.  Jika anda adalah sebahagian daripada pasukan atau jika anda berkontribusi pada sesuatu projek, anda harus mengikuti gaya yang ada dalam projek itu.

Gaya indentasi tidak benar-benar berbeza daripada yang lain.  Terkadang, mereka mencampurkan aturan yang berbeza.  Contohnya, pada Standard Pengkodean PEAR , kurung kurawal yang terbuka "{" berada pada baris yang sama sebagai kawalan struktur , tetapi mereka melewatinya ke baris seterusnya setelah fungsi definisi .

Gaya PEAR:

Perhatikan juga bahawa mereka menggunakan empat spasi, bukan tab untuk indentasi.

Berikut adalah artikel Wikipedia dengan contoh gaya indentasi yang berbeza.


3 - Hindari Komentar yang Jelas

Mengomentari kod anda adalah sangat fantastik; Namun, bisa jadi berlebihan atau hanya terlalu berlebihan.  Ambil contoh ini:

Bila teksnya sudah jelas, sebenarnya tidak produktif untuk mengulanginya dalam komentar.

Sekiranya anda perlu mengomentari kod itu, anda boleh menggabungkannya ke satu baris saja:


4 - Pengelompokan Kod

Lebih banyak daripada tidak, tugas tertentu memerlukan beberapa baris kod.  Sebaiknya simpan tugas ini di dalam blok kod yang terpisah, dengan beberapa spasi di antaranya.

Berikut adalah contoh yang disederhanakan:

Menambahkan komentar di awal setiap blok kode juga menekankan pemisahan visual.


5 - Skema Penamaan yang Konsisten

PHP sendiri kadang kadang bersalah kerana tidak mengikuti skema penamaan anu konsisten:

  • strpos () vs str_split ()
  • imagetip () vs image_type_to_extension ()

Pertama-tama, nama harus mempunyai batas kata.  Ada dua pilihan popular:camelCase : 

  • Huruf pertama: dari setiap kata dikapitalisasi, kecuali kata pertama.
  • Underscore: Underscore antara kata-kata, seperti: mysql_real_escape_string ().

Mempunyai pilihan yang berbeza membuat keadaan yang mirip dengan gaya indentasi, seperti yang saya nyatakan sebelumnya.  Jika projek yang ada mengikuti satu pertandingan, anda harus melakukannya dengan itu.  Di samping itu, beberapa bahasa platform tampil menggunakan penamaan skema tertentu. Contohnya, di Java, kebanyakan kod menggunakan nama camelCase, sedangkan di PHP, mayoritas menggunakan underscore.

Ini juga boleh dicampur.  Beberapa pengembang lebih suka menggunakan underscore untuk fungsi prosedural, dan nama kelas, tetapi menggunakan camelCase untuk nama kelas method:

Jadi sekali lagi, tidak ada gaya "terbaik" yang jelas.  Hanya bersikaplah konsisten.


6 - KERUSAKAN KERAJAAN

DRY singkatan daripada Do not Repeat Yourself.  Juga dikenali sebagai DIE: Duplikasi adalah Kejahatan.

Prinsipnya menyatakan:

"Setiap potongan pengetahuan harus mempunyai representasi otoritatif tunggal, tidak ambigu di dalam sistem."

Tujuan sebahagian besar aplikasi (atau komputer pada umumnya) adalah mengotomatisasi tugas yang berulang.  Prinsip ini harus dijaga dalam semua kod, bahkan aplikasi web.  Bahagian kod yang sama tidak boleh diulang berkali-kali.

Sebagai contoh, sebahagian besar web aplikasi terdiri daripada banyak halaman.  Ini sangat mungkin bahawa laman-halaman ini akan mengandungi unsur umum.  Header dan footer biasanya merupakan kandidat terbaik untuk ini.  Bukanlah ide yang bagus untuk tetap menyalin menyekat header dan footer ini ke setiap halaman.  Berikut ini Jeffrey Way menjelaskan cara membuat template di CodeIgniter.


7 - Hindari Persarangan yang Dalam

Terlalu banyak tingkat perbatasan dapat membuat kod lebih sulit dibaca dan diikuti.

Demi keterbacaan, biasanya memungkinkan untuk membuat perubahan pada kode anda untuk mengurangi tingkat perkarangan:


8 - Batas Panjang Baris

Mata kita lebih selesa apabila membaca teks yang tinggi dan sempit.  Inilah sebab mengapa artikel surat khabar kelihatan seperti ini:

Adalah praktik yang baik untuk mengelakkan penulisan baris kod yang panjang lebar secara horisontal.

Juga, jika ada yang ingin membaca kode dari terminal windows, seperti pengguna Vim , ada baiknya membatasi panjang baris menjadi sekitar 80 karakter.


9 - Fail dan Folder Organisasi

Dengan teknis, Anda boleh menulis keseluruhan aplikasi kod dalam satu file.  Tapi itu akan menjadi mimpi buruk untuk dibaca dan dipelihara.

Selama projek pemrograman pertama saya, saya tahu tentang gagasan dari penciptaan "include files." Namun, saya bahkan belum benar-benar teratur.  Saya membuat folder "inc", dengan dua fail di dalamnya: db.php dan functions.php .  Seiring bertumbuhnya aplikasi, fungsi fail juga menjadi sangat besar dan sulit dipelihara.

Salah satu cara terbaik adalah dengan menggunakan kerangka kerja , atau mencontoh folder struktur mereka.  Seperti inilah CodeIgniter:


10 - Nama Sementara yang Konsisten

Biasanya, variable harus deskriptif dan mengandung satu atau beberapa kata.  Tetapi, ini tidak selalu berlaku untuk sementara sementara.  Mereka boleh sesingkat satu aksara.

Ini adalah praktik yang baik untuk menggunakan nama yang konsisten untuk sementara sementara Anda yang mempunyai peran yang sama.  Berikut adalah beberapa contoh yang saya ingin gunakan dalam kod saya:


11 - Menggunakan Huruf Besar Kata-kata Khusus SQL

Pangkalan data interaksi adalah bahagian besar dari sebahagian besar aplikasi web.  Jika anda menulis query SQL mentah, itulah ide bagus untuk membuatnya tetap terbaca juga.

Walaupun kata-kata khusus SQL dan nama fungsi tidak peka terhadap huruf besar, praktik yang umum adalah menggunakan huruf besar untuk membedakannya dari nama tabel dan kolom Anda.


12 - Pemisahan Kod dan Data

Ini adalah prinsip lain yang berlaku untuk hampir semua bahasa pemrograman di semua lingkungan. Dalam kes perkembangan web, "data" biasanya menyiratkan keluaran HTML.

Ketika PHP pertama kali dirilis bertahun-tahun dahulu, ia terutama dilihat sebagai template mesin.  Sudah umum untuk memiliki besar HTML file dengan beberapa baris PHP kode di antaranya.  Namun, hal-hal telah berubah selama bertahun-tahun dan situs web menjadi lebih dan lebih dinamis dan fungsional.  Kod sekarang menjadi sebahagian besar dari web aplikasi, dan bukan lagi suatu kebiasaan yang baik untuk menggabungkannya dengan HTML.

Anda boleh menerapkan prinsip ini pada aplikasi anda sendiri, atau anda boleh menggunakan alat pihak ketiga (template mesin, kerangka kerja atau CMS) dan mengikuti konvensi mereka.

Popular PHP Kerangka:

Popular Template Mesin:

Kandungan Pengurusan Sistem Popular


13 - Sintaks Alternatif di Dalam Template

Anda boleh memilih untuk tidak menggunakan template mewah mesin, dan sebaliknya pergi dengan PHP inline biasa di template anda.  Ini tidak harus melanggar "Pemisahan Kode dan Data", jika garis inline berhubungan langsung dengan output, dan dapat dibaca.  Dalam hal ini anda harus mempertimbangkan untuk menggunakan alternatif sintaks untuk kawalan struktur .

Inilah contohnya

Ini membolehkan anda mengelakkan banyak kurung kurawal.  Selain itu, kodenya terlihat dan terasa mirip dengan cara terstruktur HTML dan terindentasi.


14 - Berorientasi Objek vs Prosedural

Pemrograman berorientasi objek boleh membantu anda membuat kod yang tertruktur dengan baik.  Tapi itu tidak bermakna anda harus meninggalkan program prosedural sepenuhnya.  Sebenarnya buat perpaduan kedua gaya itu bagus.

Objek harus digunakan untuk mewakili data, biasanya berada dalam pangkalan data.

Prosedural fungsi boleh digunakan untuk tugas tertentu yang dapat dilakukan secara independen.

15 - Membaca Sumber Terbuka Kod

Open Source projek dibangun dengan masukan dari banyak pengembang.  Projek ini perlu mempertahankan tahap keterbacaan yang tinggi sehingga pasukan dapat bekerja sama seefisien mungkin.  Karena itu, ada baiknya menelusuri kode sumber proyek-proyek ini untuk mengamati apa yang sedang dilakukan pengembang ini.


16 - Kod Refactoring

Apabila anda "refactor," anda membuat perubahan pada kod tanpa mengubah fungsi itu.  Anda bisa menganggapnya seperti "cleaning," demi meningkatkan keterbacaan dan kualitas.

Ini tidak termasuk bug perbaikan atau penambahan fungsi baru apa-apa.  Anda mungkin melakukan refactor pada kod yang telah anda tulis sehari sebelumnya, sementara masih segar di kepala anda, sehingga lebih mudah dibaca dan dapat digunakan kembali ketika Anda berpotensi melihatnya dua bulan dari sekarang.  Seperti moto mengatakan: "refaktor awal, refaktor sering."

Anda boleh mengimplementasikan salah satu "best practices" daripada kod ketepatan semasa proses refactoring.

Saya harap anda menikmati artikel ini!  Apa yang saya ketahui?  Beri tahu saya lewat komen.

Advertisement
Advertisement
Looking for something to help kick start your next project?
Envato Market has a range of items for sale to help get you started.