/ Technical

Naming Convention

Digitalisasi sudah menjadi hal yang wajar di aspek manapun, dimana kita sudah sangat terbiasa dengan dokumen dokumen digital dan media penyimpanan secara digital. Kadang ketika membuat dokumen kita menyimpannya dengan penamaan yg secara random muncul di otak. kemudian entah beberapa bulan kemudian ketika kita ingin mencari file tersebut kita kesulitan mencari karena lupa nama file nya. hal ini sering terjadi bahkan ketika file itu milik kita sendiri dan kita yg membuatnya, sedangkan di organisasi, perusahaan, atau ketika kita bekerja dalam suatu badan yg memungkinkan adanya pergantian personel dalam perjalanan nya, tentu penamaan file atau bahkan format content yang spontan seperti ini akan membingungkan apabila akan dilanjutkan. untuk itu, dibutuhkan aturan aturan dalam penamaan, format dan lain lain sehingga hal tersebut memiliki standarisasi. hal ini dikenal dengan istilah naming convention.

Dalam Software Developement hal ini sangat penting untuk dibiasakan, mengingat kebiasaan coding masing masing orang bisa saja berbeda. hal ini dimaksudkan ketika kita mengembangkan aplikasi dalam sebuah team, ada kemudahan jika menambah personil baru atau, pengembangan kedepan atau bug fixing oleh personel lain.

di gdilab, naming convention ini sudah diterapkan, sebagai contoh, antara lain adalah sebagai berikut :

  1. Penamaan package

penamaan package selalu dimulai dengan top level domain, misal com, net, org, io, dll. selanjutnya nama perusahaan dan part ketiga adalan nama applikasi, atau project. dan semua ditulis dengan lowercase alfanumeric. baru selanjutnya nama section pengelompokan class berdasarkan pattern yang kita gunakan.

contoh : com.namaperusahaan.namaaplikasi

  1. Penamaan class dan interface

dalam menamakan class kita menerapkan standar untuk mengawali class dengan huruf Kapital alfanumeric camel case, tanpa ada spesial character.

contoh : class NamaClass

  1. Penamaan variable dan method (fungsi)

untuk penaaman fungsi, kita menerapkan standar yang sama dengan penamaan class, hanya saja harus selalu diawali dengan huruf kecil.

contoh :

  • var namaVariable1

  • void namaMethod() {

}

  1. Penamaan constant

untuk constant kita menerapkan standar untuk menggunakan alfanumeric uppercase, dan underscore

contoh : static final var NAMA_CONTANTA = "";

  1. Penggunaan brachet

untuk penggunaan brachet, awal brachet selalu di tempatkan setelah nama class, nama metod method, konsidi, dan iterasi, setelah spasi dan tanpa enter

contoh :

  • class NamaClass {

}

  • void namaMethod() {

}

  • if(kondisi) {

}

- while(kondisi){

}

  1. penempatan komen / documentasi class dan fungsi

untuk setiap pembuatan class, harus diawali dengan dokumentasi yang bertujuan untuk dokumentasi sehingga tidak membingungkan dalam penggunaanya oleh orang lain.

/*

* Author : nama pembuat file

  • Created Date : tanggal file dibuat

  • Nama class

  • Descripsi Class

  • Keterangan penggunaan global variable

*/

class NamaClass {

}

komen juga ditempatkan di setiap method dan operasi khusus yang mengakibatkan operasi matematika atau logika yang khusus.

contoh :

/*

  • method name

  • description

  • @param parameter yang digunakan

  • @return hasil kembalian dari method jika ada

*/

SomeClass someMethod() {

// some matematic operation description

var someValue = someVar1 + someVar2;

}

  1. Penamaan file resources / assets

untuk file file seperti gambar yang digunakan sebagai asset atau resource aplikasi, selalu dimulai dari type asset, misal button, backgroud, image, dll. setelah itu diikuti section, misal global, main, about, register, dll. setelah itu diikuti dengan type spesific dalam halaman (section), misal ok, cancel, back, dll. kemudian di ahir adalah ukuran asset (jika ada). misal small, large, 200x200, dll.

contoh : button_register_cancel_large.png

 

Masih banyak lagi aturan-aturan lain yang dapat diberlakukan untuk lebih meningkatkan kerapihan dan standarisasi dalam masing masing project developement. Dan untuk masing masing software development atau masing masing bahasa pemprograman dapat mengaplikasikan standar yang berbeda pula. adanya standarisasi dan aturan aturan tersebut penting untuk diimplementasikan dalam sebuah team atau perusahaan, sehingga lebih  pengembangan software dapat lebih scalable.