Home > Java > Konvensi Code dalam Pemrogramman Java

Konvensi Code dalam Pemrogramman Java

Beberapa hari ini saya sering merasa “terganggu” dalam belajar pemrograman Java. Hal yang cukup mengganggu saya yaitu bagaimana penamaan variable, method dan class yang sesuai dengan konvensi ( kesepakatan umum ) dalam pemrogramman Java. Memang benar, kita bisa memberikan nama untuk variable, method dan class sesuka kita ( asal bisa running ). Tapi kebiasaan tersebut tidak baik untuk kesehatan kita😀. Jika kita memberikan nama varible, method, class dimana nama dan tujuannya tidak sesuai bisa membuat kita sendiri bisa bingung apalagi jika program yang kita buat skalanya besar. Dan dengan penamaan yang sesuai dengan konvensi, maka jika program kita dibaca oleh orang lain akan lebih mudah untuk dipahami.

Berikut ini hasil pencarian saya di google.

Untuk variable

  • Nama variable harus menggunakan deskripsi yang jelas dan dapat mewakili isi dari variable tersebut
  • Jika variable terdiri dari dua kata, kata pertama diawali dengan huruf kecil ( lowercase ) dan kata kedua diawali dengan huruf besar ( uppercase ). Contoh fileName, audioSystem.
  • Ditulis dalam bahasa inggris
  • Menggunakan prefik is jika variable bertipe Boolean. Contoh isFound, isOpen. ( Alternatif prefik yang lain antara : has, can dan should. )
  • Untuk java swing variable menggunakan suffix sesuai dengan jenis typenya. Contoh nameTextField, leftScrollbar, mainPanel.
  • Negasi nama variable dengan type Boolean harus dihindari. Contoh isFound bukan isNotFound.
  • Penggunaan singkatan harus dihindari. Contoh ActionEvent event bukan ActionEvent e
  • Penamaan konstanta / final variable adalah huruf besar ( uppercase ) dan dengan underscore untuk memisahkan antar kedua kata. Contoh   DEFAULT_NUMBER.
  • Private class variables menggunakan underscore suffix. Contoh private String name_;

Untuk method dalam Java

  • Singkatan dan akronim tidak boleh menggunakan huruf besar jika digunakan sebagai nama method. Contoh openDvdPlayer(); bukan openDVDPlayer();
  • Nama untuk method menggunakan kata kerja dan kata pertama diawali dengan huruf kecil ( lowercase ) dan kata kedua diawali denga huruf besar ( uppercase ). Contoh getName(), computeTotalWidth()
  • Menggunakan get / set untuk melakukan akses terhadapa variable. Contoh employee.getName();   employee.setName(name);
  • Kata find dapat digunakan pada method jika digunakan untuk mencari sesuatu. Contoh findSmallestElement();
  • Menggunakan prefik is jika nilai kembalian method bertipe Boolean. Contoh hasLicense();,  isOpen();. ( Alternatif prefik yang lain antara : has, can dan should. )

Untuk nama class dalam Java

  • Menggunakan huruf besar ( uppercase ) untuk setiap awal kata. Contoh PersonDetail
  • Nama harus merepresentasikan isi / detail class

Others untuk penulisan statement dalam Java

  • incompleteness of split lines harus dihindari. Contoh

totalSum = a + b + c

+ d + e;

  • Dalam import class harus eksplisit. Contoh import java.util.List; bukan import java.util.*;
  • Executable statements pada conditionals harus dihindari. Contoh

InputStream stream = File.open(fileName, “w”);

if (stream != null) { : }

bukan

if (File.open(fileName, “w”) != null))

{ : }

  • Statement if-else. Contoh

if (condition) {

statements;

}

else

{

statements;

}

  • Statement try-catch. Contoh

try {

statements;

} catch (Exception exception) {

statements;

} finally {

statements;

}

  • Menggunakan spasi dalam program. Contoh a = (b + c) * d; bukan a=(b+c)*d;

Semoga bermanfaat😀

Referensi : dari berbagai sumber

  1. No comments yet.
  1. No trackbacks yet.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: