Sebagai salah satu PHP Framework yang populer digunakan saat ini, Laravel digunakan oleh lebih dari ribuan pengembang setiap hari untuk membuat semua jenis situs web dan aplikasi. Oleh karena itu, perlu untuk melakukan standarisasi penggunaan kata atau penamaan suatu fungsi maupun nama file untuk mempermudah pengembang lain apabila ingin mempelajari source code yang kalian buat. Untungnya, ada beberapa konvensi penamaan yang sangat umum digunakan oleh banyak pengembang ketika menamai variabel, metode dan fungsi dari proyek Laravel mereka.
Nama controller
Nama controller harus dalam bentuk singular atau kata tunggal, tidak ada spasi di antara kata - kata, dan diakhiri dengan kata "Controller". Selain itu, setiap kata harus ditulis dengan huruf besar.Contoh penamaan yang benar:
BlogController, AuthController, UserControllerContoh penamaan yang salah:
UsersController (karena menggunakan kata jamak atau plural)
Users (karena tidak ada kata "Controller" diakhir nama).
Nama model
Penamaan model harus dalam bentuk kata tunggal, tidak ada spasi di antara kata - kata, dan ditulis dengan huruf kapital.Contoh penamaan yang benar:
Blog, Auth, UserContoh penamaan yang salah:
Users, ForumPosts, blogpost, blog_post, Blog_posts
Nama tabel database
Nama tabel database harus dalam huruf kecil, dengan garis bawah untuk memisahkan kata - kata (snake_case), dan harus dalam bentuk jamak.Contoh penamaan yang benar:
posts, project_tasks, uploaded_imagesContoh penamaan yang salah:
all_posts, Posts, post, blogPosts
Nama kolom tabel pada database
Hampir sama dengan tabel, nama kolom tabel database harus dalam huruf kecil, dengan garis bawah untuk memisahkan kata - kata (snake_case).Contoh penamaan yang benar:
post_body, id, created_atContoh penamaan yang salah:
blog_post_created_at, forum_thread_title, threadTitle
Nama variabel
Penamaan variabel yang baik diawali dengan huruf kecil dan menggunakan camelCase apabila penamaan variabel menggunakan lebih dari satu kata.Contoh penamaan yang benar:
$users = ...Contoh penamaan yang salah:
$bannedUsers = ....
$all_banned_users = ...
$Users=....
Nama file blade view
Penamaan file blade view pada Laravel harus dalam huruf kecil, snake_case (garis bawah atau underscore di antara kata - kata).Contoh penamaan yang benar:
all.blade.php, all_posts.blade.php, dllContoh penamaan yang salah:
all posts.php, Posts.blade.php, dll
Mungkin cukup sekian dulu tutorial singkat ini saya buat, semoga artikel ini bermanfaat. Jangan lupa share ke teman dan grup kalian untuk menambah wawasan mereka.
Sumber dan inspirasi materi: https://webdevetc.com/blog/laravel-naming-conventions
Sumber gambar: https://www.ox.ac.uk/sites/files/oxford/styles/ow_medium_feature/public/field/field_image_main/modern%20foreign%20languages.jpg?itok=-hf3NI31
0 Komentar