Standar Penamaan

Dalam pengembangan aplikasi menggunakan Laravel, sangat penting untuk mengikuti standar penamaan yang baik dan konsisten. Ini tidak hanya membantu menjaga kode tetap rapi, tetapi juga memudahkan kolaborasi dengan developer lain. Berikut adalah beberapa pedoman standar penamaan yang perlu Anda ketahui:

1. Penamaan Kelas

  • CamelCase: Gunakan format CamelCase untuk nama kelas.

    • Contoh: UserController, OrderService

  • Suffiks: Tambahkan suffiks yang sesuai untuk menunjukkan tujuan kelas.

    • Contoh: Repository, Service, Controller, Model

2. Penamaan File

  • Nama File Matching: Nama file harus sesuai dengan nama kelas yang ada di dalamnya.

    • Contoh: Jika Anda memiliki kelas UserController, nama filenya harus UserController.php.

  • Gunakan Huruf Besar: Konten file selalu menggunakan huruf besar untuk nama kelas.

3. Penamaan Namespace

  • Hierarchy: Gunakan namespace sesuai dengan struktur direktori.
    • Contoh: Untuk App\Http\Controllers, direktori Http/Controllers harus ada di dalam folder App.

4. Penamaan Variabel

  • snake_case: Gunakan huruf kecil dan pisahkan kata dengan garis bawah (_).

    • Contoh: $user_name, $order_id

  • Deskriptif: Nama variabel harus deskriptif agar jelas dengan apa yang ditangani variabel tersebut.

    • Contoh: $total_price lebih baik daripada $tp.

5. Penamaan Metode

  • camelCase: Gunakan format camelCase untuk nama metode.

    • Contoh: getUser, saveOrder

  • Menggunakan Kata Kerja: Nama metode biasanya dimulai dengan kata kerja untuk mencerminkan aksinya.

    • Contoh: createUser(), deleteOrder()

6. Penamaan Database dan Migrations

  • snake_case untuk Tabel: Nama tabel di database harus menggunakan snake_case.

    • Contoh: user_profiles, order_items

  • Menggunakan Jamak: Nama tabel biasanya dalam bentuk jamak untuk merepresentasikan kumpulan data.

    • Contoh: Gunakan users, bukan user.

7. Konvensi Penamaan Lainnya

  • Resource Routes: Ikuti konvensi Laravel untuk mendefinisikan resource routes, contohnya: Route::resource('users', UserController::class);.

  • Naming Convention untuk Middleware: Gunakan suffiks Middleware pada nama middleware.

    • Contoh: CheckAge, Authenticate


Mengikuti standar penamaan yang konsisten di Laravel akan membuat kode Anda lebih mudah dibaca, dipahami, dan dikelola. Pastikan untuk mengikuti konvensi yang telah dijelaskan di atas saat Anda mengembangkan aplikasi Laravel Anda.


PREVIOUS
NEXT