Konvensi Penulisan Kode Java Part 01 [Naming Conventions]

Sebenarnya ada banyak hal yang tergolong kedalam kesepakatan ini. Selain penamaan, ada juga tentang organisasi file, penulisan comments, cara deklarasi, cara penulisan statement, spasi, dll. Di post ini kita bahas penamaannya aja.

Oke langsung aja, sebelum mulai, ini beberapa alasan kenapa perlu ada kesepakatan dalam penulisan kode java :

  • 80% biaya software ada di fase maintenance atau pemeliharaan sehingga terjadi proses membaca kembali source code yang telah dibuat dan konvensi memudahkan engineers untuk memahami kode lebih cepat dan menyeluruh.
  • apablia software yang kamu buat adalah sebuah produk, kamu harus benar-benar menjamin tulisan kode kamu mudah dipahami. Yang dimaksud produk adalah, software dengan implementasi desain standar yang masih akan dikembangkan/di custom lagi sesuai kebutuhan user, sehingga melibatkan engineers lain/baru, dan mereka membutuhkan well documentation and well code writing.

1. Class dan Interface

Penamaan class harus menggunakan nouns, jika noun itu terdiri lebih dari satu kata, awali setiap kata tersebut dengan huruf besar, sebagai contoh: BeneficiaryEmailPenamaan class usahakan untuk sesederhana mungkin dan mudah dimengerti. Gunakan kata seutuhnya dan hindari singkatan ataupun akronim, kecuali jika penggunaan singkatan lebih memudahkan daripada nama aslinya, contohnya URL atau HTML.

2. Method

Penamaan method menggunakan verbs, jika pada penamaan class setiap awal kata diawali huruf besar, pada penamaan method khusus kata pertama awalannya menggunakan huruf kecil, contohnya : doSubmit(), getName(), download().

3. Variable

Penamaan variable sama seperti penamaan method, kata pertama diawali huruf kecil dan kata selanjutnya diawali huruf besar, tetapi ia tidak harus menggunakan verbs ataupun nouns, meskipun sering kita jumpai penamaanya menggunakan nouns, penamaanya harus bisa menjelaskan makna dari variable tersebut serta mudah diingat, contohnya int i, char *cp, float myWidth.

Jangan menggunakan sebuah huruf kecuali untuk variable yang bersifat sementara dan sekali pakai, umumnya i, j, k, m, dan n untuk integers dan c, d, e untuk characters.

4. Constants

Penamaan constants  seluruhnya harus menggunakan huruf besar dan jika terdiri dari lebih dari satu kata penggabungannya dipisahkan dengan underscore (_), contohnya int MIN_WIDTH = 4, int GET_THE_CPU = 1.

5. Package

Penamaan package ditulis seluruhnya dengan huruf kecil untuk menhindari konflik dengan class atau interface. Nama package harus menggunakan nouns dan ditulis mundur kebelakang mulai dari belakang, contohnya : com.fifa.product.model. “com” sebagai awalan menjelaskan domain .com

Contoh Source Code

package com.fifa.product.controller

public class BasePlayerController extends BaseController implements Animation{
protected static final String PLAYER_POSITION_CODE_FORWARD = "00123";
protected static final String PLAYER_POSITION_FORWARD = "forward";

public void doRun(List listPlayerData, String destination){
List dataList;
dataList.add(listPlayerData.get(2));
dataList.add(listPlayerData.get(3));
dataList.add(listPlayerData.get(4));

if (destination.equalsIgnoreCase(PLAYER_POSITION_FORWARD)){
dataList.add(PLAYER_POSITION_CODE_FORWARD);
}

dataList = callBo("playerService","run",dataList);
loadAnimation(RunAnimation.class, dataList);
}
}

referensi :
Microsystems, Sun. 1997. Java Code Convention

Advertisements

Tinggalkan Komentar - Tidak Perlu Login

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