Dalam menulis program, kita pastinya pernah bertemu dengan kata-kata yang ditulis dengan format tertentu, misalnya dalam Java: BufferedReader, Scanner, System.out.print(), atau dalam bahasa PHP seperti: strip_tags(), is_numeric(), FILTER_VALIDATE_EMAIL dan masih banyak lagi. Ternyata semua penulisan tersebut tidak asal tulis, tapi ada aturan yang diikuti. Aturan apa itu? Aturan tersebut adalah writing style.
Secara umum, gaya penulisan atau writing style adalah seperangkat aturan yang digunakan sebagai pedoman dalam penulisan kode program. Setiap bahasa pemrograman umumnya memiliki gayanya masing-masing, misalnya PHP yang menggunakan snake_case, Java yang menggunakan camelCase, dan bahasa-bahasa lainnya dengan gayanya masing-masing.
Kita sebagai pengguna bahasa pemrograman atau programmer, tentunya harus mengikuti gaya penulisan yang digunakan oleh bahasa yang kita pakai, tetapi, kita juga bisa dan boleh menggunakan gaya penulisan lain, atau bahkan gaya penulisan kita sendiri.
Daftar Isi
Apakah kita harus mengikuti Writing Guide?
Jawabannya: Ya!
Alasannya adalah untuk meningkatkan keterbacaan kode, atau biasa kita kenal dengan code readability. Alasan lainnya adalah untuk memudahkan orang lain atau programmer lain dalam membaca kode program kita.
Kode program yang kita tulis hari ini mungkin saja akan digunakan atau bahkan dikembangkan oleh orang lain, karena itulah perlu aturan dalam menulis kode program sehingga orang lain tidak akan kesulitan membaca kode program kita.
Aplikasi-aplikasi yang biasa kita gunakan saat ini biasanya dikembangkan oleh sebuah tim atau perusahaan. Dalam tim tersebut biasanya terdiri dari beberapa orang, atau bahkan ratusan orang. Untuk memudahkan komunikasi dalam tim dalam pembuatan kode, aturan gaya penulisan akan sangat bermanfaat. Jika kita melihat kode programnya, kode tersebut akan terlihat seperti hanya ditulis oleh satu orang (karena formatnya sama), padahal kenyataannya, kode itu ditulis oleh lebih dari satu orang.
Berikut ini 4 gaya penulisan yang biasa digunakan dan digunakan oleh komunitas secara luas.
Camel Case (camelCase)
Gaya penulisan camelCase adalah gaya penulisan yang menggunakan huruf kapital pada setiap huruf pertama setiap kata kecuali kata pertama. Karena formatnya itu, gaya penulisan ini disebut camelCase karena mirip dengan unta. Contoh penulisan Camel Case:
Kata: Active User Count Camel Case: activeUserCount
iniAdalahCamelCase()
$variabelDenganCamelCase
iPhone
activeUserCount
isUserExist
class userController {}
function getAllUser()
isActionAllowed()
Contoh camelCase dalam Java:
public class reportPrinter {
public static void main(String[] args) {
String reportTitle;
int reportCount;
float percentageOfReport;
}
}
Gaya Camel Case biasanya digunakan dalam bahasa pemrograman yang berorientasi objek (Object Oriented Programming, OOP). Camel Case biasanya digunakan untuk mendeklarasikan class.
Pascal Case (PascalCase)
Pascal Case adalah gaya penulisan dengan aturan huruf pertama setiap kata ditulis dengan huruf kapital. Penulisan ini mirip dengan gaya Camel Case, perbedaannya hanya terletak pada kata pertama.
Kata: Active User Count PascalCase: ActiveUserCount
PascalCase
IniAdalahPascalCase
UsingPascalCase
class BufferedReader { }
class InputStreamReader { }
class YourOwnClassName { }
Gaya Pascal Case berasal dari bahasa pemrograman Pascal. Gaya ini juga banyak digunakan oleh bahasa pemrograman yang berorientasi objek, biasanya digunakan untuk deklarasi nama class.
Snake Case (snake_case)
Jika pada gaya Camel Case dan Pascal Case karakter spasi dihapus, maka pada gaya Snake Case karakter spasi diganti dengan tanda garis bawah atau underscore. Penulisan dengan gaya snake_case biasanya lebih panjang dan mirip seperti ular.
Kata: Active User Count Snake Case: active_user_count
Gaya Snake Case banyak digunakan dalam bahasa pemrograman PHP, seperti pada framework CodeIgniter. Contoh snake case:
ini_adalah_snake_case snake_case $nama_variabel $get_user_count
Kebab Case
Gaya kebab-case menggunakan tanda strip atau minus (-) sebagai pemisah setiap suku kata, sehingga bentuknya mirip seperti kebab.
Contoh penulisan kebab-case:
kebab-case ini-kebab-case btn-primary btn-default -moz-transition data-target aria-label
Kebab case biasanya digunakan dalam penulisan CSS maupun atribut HTML. Penulisan URL juga umumnya menggunakan gaya kebab-case, misalnya: https://jurnalmms.web.id/posting/ini-adalah-url-posting-menggunakan-kebab-case/.
Satu lagi: ALL_CAPS
Apa itu ALL_CAPS? Gaya ALL_CAPS adalah pengembangan dari gaya Snake Case, hanya saja penulisannya menggunakan huruf kapital. Contohnya seperti berikut ini:
DATABASE FILTER_VALIDATE_EMAIL DB_HOSTNAME DB_USERNAME DB_PASSWORD DB_NAME
Gaya ini biasanya digunakan untuk mendeklarasikan konstanta dan biasanya digunakan pada kebanyakan bahasa pemrograman.
Jadi, mana yang seharusnya saya pakai?
Untuk menggunakan gaya mana yang akan kita pakai, sebaiknya sesuaikan dengan bahasa pemrograman yang kita pakai. Misalnya jika ngoding dengan PHP, sebaiknya kita menggunakan gaya snake_case, karena kebanyakan programmer PHP lainnya juga menggunakan gaya Snake Case sehingga bisa memudahkan dikemudian hari, misalnya jika kita ingin bertanya jika ada error, atau jika kita ingin membagikan kode kita.
Kita juga bisa menggunakan atau membuat gaya kita sendiri, asalkan konsisten dalam penggunaanya dan mudah dipahami oleh orang lain.
Jadi mulai sekarang, jangan asal-asal lagi dalam menulis kode program. Selalu perhatikan aturan yang sudah disepakati oleh komunitas (biasanya disebut code convention).