Apa itu naming convention?

Naming convention atau konvensyen penamaan adalah satu set peraturan urutan aksara yang telah dijadikan amalan untuk digunakan sebagai pengenal (identifier) yang  menanda dan mengenal variable, type, function dan segala jenis entiti didalam pengaturcaraan komputer. Terdapat beberapa hal yang membantu para pengaturcara (programmer) menguruskan sumber kod (source code) dan dokumentasi.

Antaranya ia mengurangkan daya atau usaha yang diperlukan untuk membaca dan memahami sumber kod. Kita pun sedia maklum karangan bahasa melayu juga perlukan pembacaan yang teliti untuk memahami isi kandungan, begitu juga dengan pengaturcaraan.

Jadi ia sedikit sebanyak membantuk para pengaturcara untuk fokus pada isu yang penting dalam pengaturcaraan dan tidak tertumpu kepada syntax dan standard nama sahaja. Kerja-kerja penelitian kod secara automatik juga dapat dilakukan dengan menggunakan alatan tersedia jika kita mengikuti standard yang telah ditetapkan. Perkara ini sangat penting terutama apabila kita berkerja secara berkumpulan.

Baca lebih lanjut disini: A Brief Guide to Clean Code: Naming Conventions

Apa kena mengena dengan case style?

Dalam pengaturcaraan juga apabila memberi nama, kita tidak boleh menulis space atau ” ”  bagi membentangkan idea atau konsep yang mengekspresikan bahasa manusia menerusi 2 perkataan atau lebih. Jadi nak tak nak kita perlukan mengantikan dengan underscore atau “_” atau dengan cara lain.

Jadi disitulah case style atau gaya penulisan kes memainkan peranan. Kejayaan dalam menamakan adalah mengetahui jenis kes yang anda ingin gunakan supaya anda boleh mempunyai konvensyen yang konsisten bagi setiap projek / ruang kerja. Contoh yang paling mudah adalah seperti berikut:

var totalPerson = 32;

kita tak pernah tulis pula macam ni.

var total Person = 32;

Itu antara contoh paling mudah tentang apa itu case style. Kita akan menulis totalPersondidalam variable (dirapatkan) berbanding total person(dijarakkan). Gaya penulisan yang kosisten ini sangat penting dalam kerja-kerja pengaturcaraan dalam pasukan.

Persoalan yang timbul pula bagaimana camel case, snake case, kebab case dan pascal case ditulis ketika mengaturcara program komputer?

1. Camel Case

Camel case mesti dimulakan dengan lowercase letter untuk permulaan huruf pertama dan capital letter untuk permulaan perkataan kedua dan seterusnya. Jangan lupa juga dibuang space diantara perkataan tersebut. Berikut adalah contoh camel case.

//perkataan
price rate

//penulisan variable
var priceRate = "RM900";

Nampak tak perkataan tersebut dirapatkan dan huruf besar digunakan untuk perkataan seterusnya. Variable price rateditulis sebagai priceRate. Ini antara cara yang popular untuk mengabungkan perkataan. Kebiasaannya  camel case ini dijadikan konvensyen untuk declare variable di kebanyakan bahasa pengaturcaraan.

2. Snake Case

Snake case ini tersangatlah mudah, hanya gantikan space kepada underscore atau “_” dengan kesemua perkataan ditulis dengan huruf kecil. Jika anda ingin menulis dengan huruf besar pula, semua perkataan perlu ditulis dengan huruf besar walaupun perkataan pertama.

Contoh adalah seperti berikut:

//contoh perkataan
total user

//contoh snake case lowercase
$total_user = mysql_query("SELECT total_user FROM user");

//contoh snake case upper case
const TOTAL_USER = 100;

Gaya penulisan ini menjadi asas penulisan kod kebanyakan pengaturcara (programmer) diluar sana. Jika anda ingin menulis dalam bentuk capitalcase letter seperti TOTAL_USER, kebiasaannya ia dijadikan konvensyen untuk declare constants untuk kebanyakan bahasa pengaturcaraan. Jika anda menulis dalam lowercase letter pula seperti total_user, kebiasaannya ia dijadikan gaya penulisan untuk declare database field name.

3. Kebab Case

Kebab case ini adalah gabungan perkataan yang dihubungkan antara satu sama lain dengan dash atau “-” dan kebiasaannya ianya ditulis dalam lowercase letter. Contohnya adalah seperti berikut:

https://azmirshah.com/apa-itu-ekonomi-gig/

Gaya ini sangat biasa digunakan didalam penulisan URL. Contoh diatas adalah contoh bagaimana menerusi Kebab case ini, URL dapat dihasilkan dengan kemas, cantik dan boleh dibaca walaupun perkataannya digabungkan. Selain daripada itu, Kebab case juga digunakan untuk kelas dan ID di HTML dan CSS.

4. Pascal Case

Pascal case ini adalah sesuatu agak mudah untuk diingat. Ianya hampir sama seperti Camel case akan tetapi ada sedikit berbeza dimana jika setiap perkataan digabungkan, ianya harus dimulakan dengan huruf besar.

Contohnya adalah seperti berikut:

//contoh perkataan
rectangle shape

//contoh pascal case
class RectangleShape {
  constructor(height, width) {
    this.height = height;
    this.width = width;
}

Ianya akan ditulis RectangleShapeuntuk perkataan rectangle shape. Penulisan gaya ini sangat popular untuk membentuk satu konsep tunggal dalam pengaturcaraan. Ianya sering digunakan sebagai konvensyen dalam mengisytiharkan kelas dalam banyak bahasa pengaturcaraan.

Gaya penulisan mana yang terbaik?

Dukacita dimaklumkan tidak ada pun gaya penulisan terbaik. Hahaha. Anda boleh gunakan konvensyen mana yang anda suka. Namun ada beberapa perkara perlu dititik beratkan.

Baca juga: Apa itu Laravel? Adakah ia lebih baik berbanding Core PHP?

Baca juga: 4 aplikasi rekaan UI/UX yang menjadi kegemaran saya

Pertama pastikan anda konsisten dalam penggunakan gaya penulisan dalam mengaturcara program anda. Jangan sekejap pakai camel case, sekejap pakai snake case untuk satu-satu class name atau sebagainya. Kalau kerja seorang pun pening, kerja beramai-ramai lagi pening.

Kedua pula jika anda kerja dalam pasukan (sudah semestinya), pastikan konvensyen yang dipilih mendapat persetujuan bersama. Ini bagi memastikan kerja anda ini dapat mengurangkan usaha yang diperlukan untuk membaca dan memahamkan kod. Jadi lebih mudah bagi pasukan untuk fokus kepada penilaian kod dan isu yang penting berbanding membebel dengan syntax dan naming standard yang tidak sama.

Ketiga, rujuk kembali konvensyen penulisan mengikut bahasa pengaturcaraan yang anda tulis. Setiap bahasa mempunyai amalan dan konvensyen yang berbeza. Sebagai contohnya untuk javascript, Camel case digunakan untuk variable dan method, pascal case untuk type dan class dan Snake case untuk constants. Saya juga seperti artikel ini, saya menulis bagi memperkenalkan case style kepada anda, jadi penulisan lebih kepada berbentuk umum.

The post Beza camel, snake, kebab dan pascal case dalam penulisan kod appeared first on Azmir Shah.