Unlimited Plugins, WordPress themes, videos & courses! Unlimited asset downloads! From $16.50/m
Advertisement
  1. Code
  2. Cheat Sheets

Standar Pengkodean WordPress: Indentasi, Penggunaan Spasi, dan Spasi Tambahan

by
Length:ShortLanguages:
This post is part of a series called The WordPress Coding Standards.
The WordPress Coding Standards: Single Quotes and Double Quotes
The WordPress Coding Standards: The Ternary Operator and Yoda Conditions

Indonesian (Bahasa Indonesia) translation by ⚡ Rova Rindrata (you can also view the original English article)

Seluruh tujuan dari seri ini untuk membantu mengekspos Standar Pengkodean WordPress, mengapa mereka penting, dan bagaimana menulis kode WordPress yang berkualitas. Untuk melakukannya, kita mengambil pandangan mendalam pada setiap bagian dari Standar Pengkodean WordPress.

Sejauh ini, kita telah membahas:

  • Konvensi Penamaan dan Argumen Fungsi
  • Tanda Kutip Tunggal dan Tanda Kutip Ganda

Hari ini, kita akan membahas pentingnya whitespace. Khususnya, kita akan mencakup indentasi, penggunaan spasi, dan spasi tambahan. Semudah kedengarannya, ini adalah beberapa dari aspek pengkodean standar yang paling diabaikan atau disalahgunakan.


Sepatah Kata Tentang Whitespace

Sebelum kita melihat apa yang terjadi dengan berbagai standar pengkodean, penting untuk memahami mengapa whitespace penting tidak hanya di WordPress, tapi dalam bahasa pemrograman secara umum.

Sederhananya, itu karena untuk meningkatkan keterbacaan.

Inilah mengapa beberapa bahasa pemrograman adalah spasi atau tab delimited, mengapa beberapa bahasa pemrograman meminta Anda memberi ruang bagian-bagian tertentu dari kode tersebut sebagai parameter fungsi, indeks array, dan banyak lagi.

Ketika mengenai WordPress, konvensi-konvensi tersebut di tempat yang tidak hanya untuk keterbacaannya, tetapi juga untuk memberikan pengalaman membaca dan pengembangan yang konsisten untuk semua orang yang bekerja pada tema, plugin, aplikasi, atau aplikasi inti WordPress itu sendiri.

Ingat: Tujuan standar pengkodean adalah untuk membuat kode sumber terlihat seolah-olah ditulis oleh pengembang tunggal karena menetapkan tingkat harapan untuk pengembang yang berkontribusi.


Indentasi

Sejauh menyangkut indentasi, tidak ada yang sangat baru, revolusioner, atau berbeda yang terkait dengan WordPress. Secara umum, Anda bisa indent setiap kali Anda memulai sebuah blok baru.

Ini berarti bahwa:

  • Fungsi Anda akan diindentasikan di dalam kelas
  • Kondisional dan switch/case Anda dan blok lain akan diindentasikan dalam fungsi mereka
  • Loop Anda akan diindentasikan dalam fungsi mereka, dalam kondisional mereka, dan sebagainya

Jika Anda terbiasa menulis kode dalam bahasa bergaya-C, maka tidak ada yang sangat baru di sini, kan?

Sebuah contoh dari apa yang mungkin terlihat persis seperti ini:

Menurut Standar Pengkodean:

Indentasi Anda harus selalu mencerminkan struktur logis. Gunakan tab nyata dan bukan spasi, karena hal ini memungkinkan fleksibilitas yang paling banyak pada klien.

Kuncinya adalah bahwa awal dari garis harus dimulai dengan tab, dan bahwa kode harus mencerminkan struktur logika. Jangan memperumit atau mencoba untuk menyederhanakan sesuatu.

Ada satu nuansa putih ruang dalam Standar Pengkodean WordPress: Tab harus digunakan pada awal baris, tapi spasi yang harus digunakan di tempat lain. Untuk sebagian besar, ini adalah aturan yang mudah diikuti, namun, di WordPress, Anda sering akan membuat array untuk menyampaikan sebagai argumen.

Idealnya, kami ingin setiap indeks array untuk berbaris sehingga keterbacaannya setinggi mungkin tapi kita sering memiliki kecenderungan untuk menggunakan tab untuk membuatnya lebih mudah untuk menatanya, tapi ini benar-benar pelanggaran pengkodean standar.

Karena itu, pastikan bahwa Anda hanya menggunakan tab di bagian awal setiap baris.


Penggunaan Spasi

Karena berkaitan dengan WordPress, saya telah menemukan bahwa spasi telah digunakan jauh lebih bebas dari pada bahasa-bahasa lain. Saya tidak mengatakan ini hanya sebagai sebuah pengamatan, karena itu adalah penyesuaian pribadi yang saya butuhkan yang datang baik dari .NET dan Ruby.

Yang katanya, seperti kebanyakan pedoman lain dalam Codex, tidak ada yang terlalu kompleks; namun, ada beberapa perbedaan penting yang perlu diingat ketika menulis kode.

Spasi harus ditempatkan di tempat-tempat berikut:

  • Setelah koma
  • Di kedua sisi operator logika (yaitu, ||&&, dan !)
  • Di kedua sisi operator perbandingan (yaitu, <>=====, dll.)
  • Di kedua sisi operator penugasan (yaitu =)
  • Di kedua sisi pembukaan dan penutupan kurung fungsi, kondisional, loop, dan sebagainya.
  • Bila variabel yang disampaikan sebagai indeks dari array, tetapi tidak ketika nilai literal (seperti string atau integer)

Sebagian besar adalah relatif langsung, tetapi dalam pengalaman saya, saya telah menemukan bahwa aturan array yang cenderung paling banyak mengakibatkan kebingungan di kalangan pengembang, jadi di sini adalah catatan singkat tentang apa yang dianggap benar dan apa yang tidak:

Seperti yang Anda lihat, itu tidak sangat rumit tapi itu konvensi yang relatif mudah untuk dilewatkan.


Spasi Tambahan

Aturan ini mungkin standar termudah untuk mengingat mereka dari semuanya. Sederhananya, tidak boleh ada spasi tambahan yang tersisa pada akhir setiap baris kode.

Tergantung pada IDE, Anda mungkin memiliki filter ini built-in; lain waktu, Anda mungkin perlu menginstal sebuah plugin yang akan melakukan tindakan ini untuk Anda setiap kali Anda menyimpan file. Tapi apapun yang terjadi, itu fitur yang relatif mudah untuk mengintegrasikan dalam IDE apapun yang Anda gunakan.

Selain itu, kebanyakan editor - terlepas dari apakah itu editor teks yang dimuliakan atau IDE penuh - Anda harus memiliki kemampuan untuk mengaktifkan tampilan tab dan spasi.

Viewing Tabs and Whitespace
Melihat Tab dan Whitespace di Coda 2

Sekali lagi, ini adalah salah satu konvensi yang paling sederhana untuk diikuti dan kemungkinan bahwa IDE Anda atau editor pilihan Anda memiliki fitur ini atau plugin yang tersedia yang akan memungkinkan Anda untuk secara otomatis melakukan hal ini.

Jika tidak, Anda harus dapat mengaktifkan kemampuan untuk melihat tab, spasi, tombol kembali, dan sebagainya sehingga Anda dapat dengan mudah mengidentifikasi di mana letak spasi tambahan.


Kesimpulan

Yang jelas, whitespace menempati peran penting dalam penulisan kode berbasis WordPress. Dalam artikel ini, kita telah mengeskplorasi indentasi, tab, spasi, spasi tambahan, dan mengapa, dan bagaimana untuk memasukkan mereka ke dalam proyek-proyek kita.

Dalam artikel berikutnya, kita akan melanjutkan pembicaraan tentang seluk-beluk Standar Pengkodean WordPress dengan melihat gaya kurawal, regular expression, dan nuansa dari menggunakan tag PHP melalui kode WordPress kita.

Advertisement
Advertisement
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.