Clean Code - Metode Penulisan Variable Kode Program
Sebagai seorang programmer, penting untuk menulis kode yang mudah dibaca (readable), mudah dipelihara (maintainable), dan konsisten, agar kode tersebut dapat bertahan dalam jangka waktu yang lama. Hal ini menjadi penting mengingat adanya kemungkinan pembaruan dari bahasa pemrograman yang digunakan.
Salah satu cara untuk mencapai tujuan tersebut adalah dengan menerapkan prinsip clean code. Di antara berbagai prinsip clean code, konvensi penamaan (naming convention) merupakan komponen yang krusial dan fundamental. Penerapan konvensi penamaan yang tepat membantu meningkatkan keterbacaan, pemeliharaan, dan keberlanjutan kode program secara keseluruhan.
Gambar Ilustrasi Naming Conventions.
Sumber Ezzy Learning
Hal ini sangat penting diketahui sebelum memulai membuat kode program, bayangkan saja ketika seorang programmer membuat penamaan variabel maupun fungsi dengan cara yang tidak konsisten, bisa dipastikan akan banyak mengalami permasalahan, baik saat akan memanggil fungsi atau variable yang diinginkan, belum lagi ketika terdapat pembaharuan fitur dari kode program yang dibangun.
Untuk itu penting adanya kesepakatan (konvensi) penamaan pada pembuatan kode program baik untuk penamaan variabel, fungsi, atribut, kelas, dsb. Berikut ini daftar konsolidasi (usaha menyatukan) konvensi penamaan penulisan kode program yang paling umum (didasarkan pada kebiasaan programmer).
| Naming | Description | Example |
|---|---|---|
| Pascal Case | Ditulis berdasarkan aturan bahasa Pemrograman Pascal, dengan aturan/notasi setiap huruf dari satu atau beberapa kata diawali dengan huruf kapital (upper case) dan digabungkan. | Contoh: FirstName, LastName |
| Camel Case | Jika notasi penulisan kata pada Pascal Case diawali dengan huruf kapital, maka pada Camel Case diawali dengan huruf kecil (lower case). Namun penulisan kata berikutnya setiap huruf diawali dengan (upper case) dan digabungkan, sehingga terlihat seperti punuk unta. | Contoh: firstNName, lastName |
| Snake Case | Semua huruf ditulis dengan huruf kecil (lower case) dengan memisahkan kata menggunakan garis bawah "_" atau (underscore), sehingga terlihat seperti "ular" atau tidak terputus atau saling menyambung. | Contoh: first_name, last_name |
| Kebab Case | Jika pada Snake Case setiap kata dipisahkan menggunakan underscore, namun pada Kebab Case dipisahkan menggunakan data pisah "-" (dash), sehingga terlihat seperti sate kebab. | Contoh: first-name, last-name |
| Lazy Case | Notasi penulisan kata seluruhnya menggunakan huruf kecil (lower case), sehingga penulisan menggunakan metode ini tidak disarankan untuk penulisan variabel maupun fungsi, namun diperlukan untuk pendefenisian pada pembuatan struktur kode program. | Contoh: firstname, lastname |
| Screaming Case | Notasi penulisan kata seluruhnya menggunakan huruf besar (upper case), sehingga penulisan menggunakan metode ini juga tidak disarankan untuk penulisan variabel maupun fungsi, namun diperlukan untuk pendefenisian pada pembuatan struktur kode program . | Contoh: FIRSTNAME, LASTNAME |
Implementasi Naming Convention
Pengimplementasian naming convention pada penulisan kode program tidak bergantung pada satu bahasa pemgrograman saja. Artinya penulisan kode program pada satu bahasa pemrograman dapat/umumnya menggunakan keseluruhan dari daftar konsolidasi konvensi, seperti ketika menuliskan nama Class menggunakan Pascal Case/Screaming Case, penulisan nama function menggunakan Camel Case, penulisan variable menggunakan Snake Case/Lazzy Case, dan penulisan attribute menggunakan Kebab Case.
// Class menggunakan PascalCase
class UserProfile {
// Variable menggunakan snake_case
private $user_name;
private $email_address;
// Function menggunakan camelCase
public function setUserData($user_name, $email_address) {
$this->user_name = $user_name;
$this->email_address = $email_address;
}
public function getUserData() {
return [
'user_name' => $this->user_name,
'email_address' => $this->email_address
];
}
}
// Instansiasi class
$user_profile = new UserProfile();
$user_profile->setUserData('agus_triawan', 'tri@idraya.com');
// Ambil data untuk ditampilkan
$user_data = $user_profile->getUserData();
Penjelasan Singkat
| Komponen | Contoh | Konvensi |
|---|---|---|
| Class | UserProfile |
PascalCase |
| Function | setUserData() |
camelCase |
| Variable | $user_name |
snake_case |
| HTML Attribute | data-user-id |
kebab-case |
<!DOCTYPE html>
<html lang="id">
<head>
<meta charset="UTF-8">
<title>Profil Pengguna</title>
</head>
<body>
<h1>Data Pengguna</h1>
<!-- Attribute HTML menggunakan kebab-case -->
<div data-user-id="001" aria-label="user-profile-section">
<p><strong>Nama:</strong> <?= htmlspecialchars($user_data['user_name']) ?></p>
<p><strong>Email:</strong> <?= htmlspecialchars($user_data['email_address']) ?></p>
</div>
</body>
</html>
Dengan menerapkan naming convention yang konsisten sebagaimana dicontohkan pada kode PHP dan HTML di atas, pengembang dapat membangun fondasi yang kuat untuk kolaborasi jangka panjang. Selain mempermudah proses pemeliharaan dan dokumentasi, gaya penamaan yang terstandar juga meminimalkan potensi kesalahan saat membaca atau memodifikasi kode. Oleh karena itu, memahami dan membiasakan diri dengan konvensi penamaan sejak dini merupakan langkah strategis dalam meningkatkan profesionalisme dan kualitas pengembangan perangkat lunak.
Warning!
We are not responsible for any loss whatsoever due to this site, also if you want to take this article please read terms of use or touch us via contact page.
If there is question, please discuss below. Very welcome and expected to provide corrections, criticisms, and suggestions.
Be the first :D
