Pentingnya Standar Dalam Melakukan Coding & Standar Kode BE Eventeer

28 June 2024 | Author: Back End KM#6

Hallo teman-teman magang, artikel ini untuk kamu yang ingin tahu bagaimana saya ngoding di role BE magang sebelumnya ya, jadi baca sampai akhir karena sangat penting!!!

Pengantar

Standar coding adalah serangkaian pedoman yang mengatur cara penulisan kode dalam pengembangan perangkat lunak atau aplikasi. Pedoman ini dirancang untuk memastikan bahwa kode yang ditulis oleh developer agar tetap konsisten, mudah dibaca, dan mudah dipelihara. Standar coding berperan penting dalam meningkatkan kualitas, efisiensi, dan keamanan aplikasi yang dikembangkan.

Manfaat Standar Coding

1. Kualitas dan Konsistensi

Kualitas: Standar coding memastikan bahwa semua developer mengikuti praktik terbaik, yang menghasilkan kode berkualitas tinggi.

Konsistensi: Dengan mengikuti standar yang sama, kode yang ditulis oleh berbagai developer dalam tim akan memiliki gaya yang seragam, membuatnya lebih mudah dipahami dan dipelihara.

2. Kemudahan Pemeliharaan

Kode yang konsisten dan terstruktur dengan baik memudahkan proses debugging dan pemeliharaan. Developer baru yang bergabung dengan proyek dapat dengan cepat memahami kode yang ada dan mulai bekerja tanpa perlu banyak penyesuaian.

3. Kolaborasi yang Lebih Baik

Standar coding memfasilitasi kolaborasi antar developer. Dengan menggunakan konvensi yang sama, komunikasi antar anggota tim menjadi lebih efisien dan efektif. Developer dapat dengan mudah memahami dan mengedit kode satu sama lain.

4. Keamanan

Standar coding sering kali mencakup pedoman untuk menghindari praktik yang dapat menyebabkan kerentanan keamanan. Dengan mengikuti standar ini, risiko bug dan celah keamanan dapat dikurangi.

5. Aturan Regulasi Industri

Dalam industri tertentu, seperti keuangan dan kesehatan, kepatuhan terhadap standar coding dapat menjadi keharusan untuk memenuhi regulasi dan standar industri. Hal ini memastikan bahwa perangkat lunak yang dikembangkan memenuhi persyaratan hukum dan regulasi yang berlaku.

6. Efisiensi Pengembangan

Dengan mengikuti standar coding, proses review kode menjadi lebih mudah dan cepat. Developer tidak perlu menghabiskan banyak waktu untuk memahami gaya coding yang berbeda, sehingga proses pengembangan menjadi lebih efisien.

Beberapa Standar Spesifik yang digunakan bahasa pemrograman

Ada banyak sekali bahasa pemrograman yang digunakan oleh developer saat ini, dan banyak juga standar yang diterapkan oleh setiap developer, namun dibawah ini adalah beberapa standar yang diberikan langsung oleh pembuat bahasa pemrogramannya sendiri, sebagai acuan dan bahan belajar :

Standar yang Saya Gunakan di Digital Amoeba

Adapun standar yang saya gunakan sehari-hari di keseharian saya 5 bulan magang di Digital Amoeba sebagai Backend Developer. Berikut beberapa penjelasannya :

1. Menyamakan Extension

Yang pertama adalah pentingnya extensi yang sama, extensi ini hanya berlaku untuk developer yang menggunakan Visual Studio Code sebagai IDE yang digunakan dalam pengembangan aplikasi. Hal ini saya temukan sangat penting dari pengalaman saya melakukan kolaborasi dengan developer lain.

Berikut adalah poin-poin yang harus diperhatikan :

  • Pastikan tidak ada yang menggunakan extensi Auto Correcttion / Auto Align di Vscode seperti Prettier, ESLint, EditorConfig dan lainnya. Hal ini saya temukan dapat sangat menggagu kerapihan kode, karena jika ada orang yang tidak menginstall extensi ini akan merubah kerapihan kodingan sebelumnya. Ini merupakah hal minor tapi lumayan berguna
  • gunakan GitLens karna setiap line kode bisa dilihat oleh siapa dan kapan kode dirubah

2. Menyamakan Spaces Indentation

Yang kedua adalah menyamakan Spaces Indentation. Bisa dilihat pada gambar di paling pojok kanan bawah Terdapat “Spaces 4” ini adalah spaces indent yang saya gunakan, bisanya juga saya menggunakan spaces sebanyak 2, jika kodingan banyak yang panjang secara horizontal.

Developer lain harus menyamakan jumlah indent, karena ketika proses pull, jika developer lain memiliki default indent yang berbeda, setiap kali melakukan pull & push, kodingan akan acak-acakan karena perbedaan ini.

3. Berikan Dokumentasi Yang Jelas

Pada gambar-gambar diatas dapat dilihat beberapa dokumentasi yang sebelumnya saya buat. dokumentasi ini berupa Comment-comment yang saya buat dalam menjelaskan kodingan saya.

  • Pada gambar ke-1 berupa penjelasan per-blok kode penjelasan atau judul dari kode nya,
  • Lalu di gambar ke-2 jika lebih dari 1 blok kode maka menggunakan 2 comment yang berbeda namun comment yang kedua mengunakan kata “END” di dalam commentnya yg menandakan batas kategori kode.
  • Di gambar ke-3 ada semacam kata yang sama dan tidak digunakan di comment kode lain yaitu
    “(CM)”. Ini bisa memudahkan proses search kode dengan Search across files (ctrl+shift+f) di vscode untuk mencari kode mana saja yang di CM / Community Manager contohnya.
  • Selanjutnya di gambar ke-4 terdapat penjelasan masing-masing per line kode, hal ini diperlukan jika perlu ada penjelasan per line kodenya
  • dan terkahir adalah penulisan fungsi IF jika didalamnya hanya ada 1 line kode. Biasanya saya menghilangkan {} dan menyatukan menjadi 1 baris saja. exp : if ($response > 0) get_response(200, $result); . ini akan membuat kode menjadi lebih rapih (menurut saya). Dapat dilihat di semua gambar saya menerapkan ini.

Selain Dokumentasi pada kode kita, kita juga perlu melakukan Dokumentas Postman kita.

Pada gambar disamping dapat dilihat terdapat folder V1,V2 dan seterusnya. ini adalah Perumpamaan directori yang sama pada kodingan. Di kodingan nya sendiri terdapat bagian controllers yang didalamnya terdapat beberapa folder terpisah juga seperti V1, V2, dan V3. Hal ini disamakan pada struktur folder di postman juga.

lalu selain itu terdapat beberapa folder lagi didalamnya, seperti Ads, Genre, dst. Ini adalah perumpamaan Nama Halaman yang akan digunakan API, seperti Dashboard, didalamnya terdapat Halaman Event Activity, lalu didalamnya lagi terdapat 3 pilihan Submission, Agenda dan Speaker. Setiap folder ini akan membantu Front End dalam menemukan API dan memahami API tersebut.

Dan yang terakhir adalah selalu menyertakan API Example, seminimal mungkin terdapat 3 kondisi yaitu Success, Data not found dan Internal Server Error.

Standar coding memainkan peran penting dalam pengembangan perangkat lunak yang berkualitas dan aman. Dengan mengikuti standar ini, tim pengembang dapat meningkatkan kualitas, efisiensi, dan keamanan kode yang mereka tulis. Implementasi standar coding yang baik membutuhkan pemilihan standar yang tepat, edukasi, penggunaan alat bantu, dan review kode secara berkala. Dengan demikian, standar coding bukan hanya sekadar pedoman teknis, tetapi juga alat penting untuk meningkatkan kolaborasi dan efisiensi dalam pengembangan perangkat lunak.

Harapannya juga teman-teman bisa menggunakan standar yang sama ya, agar kodingan nya tetap terjaga kerapihan, kesamaan, dan tidak acak-acakan. Kurang lebih seperti ini penjelasannya guys, Terimakasih sudah mau membaca artikel ini, sampai jumpa lagi 👋.

Ditulis oleh Backend Developer Intern at Digital Amoeba MSIB Batch 6
Raie Aswajjillah – Universitas Islam Nusantara (linkedin.com/in/raie-aswajjillah)