Java Coding Guidelines & Best Practices

 File Structure for Java Source Files

 File naming guidelines
 Directory structure
 File structure
 Class Structure for Java Source Files
 Class Header
 Static/Instance variable field declarations
 Static initializer
 Static member inner class declarations
 Method Declarations
 Instance initializer
 Constructor declarations
 Naming Guidelines
 General concepts in Naming
 Article Naming Convention
 Source Code Style Guidelines
 Line Spacing
 Blank Space
 If/else
 For
 While
 Do…While
 Switch
 Try/Catch/Finally
 Comments.
 Block Comments
 Trailing Comments
 Single Line comments
 Documentation comments
 Standard Java Coding Conventions
 Declarations
 Statements
 Import Declaration
 Blank Spaces
 Indentation
 Continuation Lines
 Member documentation comments
 Class and instance variable field declarations
 Exception handling
 Eclipse Plugins for Code Styling
1.1- File Structure for Java Source Files

Let’s first go through what Java coding guidelines say about the file management.

1.1.1- File naming guidelines.

Program Java harus menggunakan akhiran file berikut.

Note : Nama file sumber Java harus sama dengan nama class atau antarmuka yang
terkandung dalam file itu

1.1.2- Directory structure

1.1.3- File structure

Sesuai pedoman pengkodean Java, proyek harus menyertakan bagian berikut.
 File Header.
 Package Name.
 Imports.
 Class definition.

1.1.3.1- File Header

 Sertakan header file seperti yang disediakan di bawah ini.

1.1.3.2- Package Name

Nama package harus muncul pada baris pertama yang tidak dikomentari
dari file sumber dan harus mengikuti konvensi penamaan yang ditentukan
dalam dokumen ini.

1.1.3.3- Imports
Nama package harus nama class yang diimpor.

1.1.3.4- Class definition

Segera setelah impor harus menjadi definisi class.
1.2- Class Structure for Java Source Files

Class Java harus terdiri dari bagian-bagian berikut.

1- Class Header.
2- Static/Instance variable field declarations.
3- Static initializer.
4- Static member inner class declarations.
5- Method declarations.
6- Instance initializer.
7- Instance constructor declarations.

Note: The class instance, static variables, and methods should fall in public, protected,
default, and then private accessibility order. All public fields should have documentation
comment.

1.2.1- Class Header

Header class harus dimasukkan seperti yang diberikan dalam format di bawah ini.

1.2.2- Static/Instance variable field declarations

Variabel statis harus didahulukan dan mulai deklarasi mereka dengan kata kunci <static>.
Variabel instan tidak perlu diawali dengan kata kunci <static>.

Note :

Beberapa poin penting yang harus Anda perhatikan.

 Selalu dapatkan deklarasi field dalam baris terpisah.
 Field atau class yang tidak berubah setelah inisialisasi harus dinyatakan final.
Pendekatan ini memungkinkan kompiler untuk menghasilkan kode yang lebih baik.
 Pastikan untuk menyelaraskan nama field sehingga semuanya dimulai di kolom
yang sama.
 Jangan tinggalkan variabel apa pun tanpa penentu akses.
1.2.3- Static initializer
A static initializer, if any, comes next. It must have the following form.

1.2.4- Static member inner class declarations

Inner class yang statis dituliskan di dalam class. Dan class-class semacam itu harus
mengikuti struktur berikut.

1.2.5- Method Declarations

Setiap metode Java harus memiliki deskripsi yang ditautkan dalam format <javadoc>.
Berikut adalah contoh <javadoc> yang akan digunakan untuk metode publik.

Metode standar dapat menghindari deskripsi dikelompokkan menggunakan salah satu

pengelompokan logis berikut.
1- Factory
2- Private
3- Protected
4- Interfaces
5- Accessor
6- Temporal
7- I/O
8- Debugging
1.2.6- Instance initializer
An instance (non-static) initializer, if any, comes next.

1.2.7- Constructor declarations

Constructor declarations, if any, come next.

Jika ada beberapa konstruktor dan beberapa memiliki lebih banyak parameter, maka
mereka akan muncul setelah mereka dengan lebih sedikit parameter. Ini berarti bahwa
konstruktor tanpa argumen harus selalu menjadi yang pertama.

1.3- Naming Guidelines

Itu adalah salah satu pedoman pengkodean Java yang tergantung pada konteks tempat
Anda berada.
1.3.1- General concepts in Naming
1- Ikuti strategi penamaan terkait domain.
2- Gunakan sentence case untuk membuat nama dapat dibaca.
3- Hati-hati menggunakan singkatan.
4- Cegah penggunaan nama yang berlebihan.

1.3.2- Article Naming Convention

1.3.2.1- Arguments or parameters
Gunakan nama terkait untuk nilai / objek yang diteruskan, dan awalan dengan
<arg> atau <param>.
e.g. argEmpName, paramSalary etc.

1.3.2.2- Fields and Variables

Mulai bidang / nama variabel dalam huruf kecil dan kemudian lanjutkan dalam
kalimat.
e.g. clickCheckBox, viewInfo, openWindow.
Jangan gunakan garis bawah untuk memulai atau memisahkan kata-kata.

1.3.2.3- Constants
Gunakan huruf besar dan garis bawah untuk membentuk konstanta.
e.g. static final int MAX_SIZE = 256;
static final string BROWSER_TYPE = “Chrome”;

1.3.2.4- Classes and Interface

Selalu mulai nama class / antarmuka dengan huruf kapital.
e.g. Class Name: PageFactory or PageObject.
Interface Name: IpageObjectModel

1.3.2.5- Compilation unit Files

Gunakan nama class atau antarmuka yang diawali dengan <.java> untuk
menyatakan bahwa itu adalah file kode sumber.
e.g. TestPage.java, UIMap.java, LoginPage.java.
1.3.2.6- Component
Gunakan nama yang bermakna dengan akhiran yang tepat.
misalnya CategoryMenu, listView dll.
1.3.2.7- Packages
Mulai nama package dengan nama domain tingkat atas seperti com, edu, gov, dll.
Ikuti Standar ISO 3166, 1981. Bagian yang tersisa dapat bervariasi sesuai dengan
struktur penamaan internal organisasi.
e.g. com.techbeamers.testpackage.
1.3.2.8- Member Function
 Memiliki nama fungsi yang berkaitan dengan tugas yang dimaksudkan. Mulailah
dengan kata kerja aktif jika memungkinkan.

Good method names

showStatus(), drawCircle(), addLayoutComponent().

Bad method names

menuButton() – noun phrase; doesn’t describe function.

OpenTab() – starts with upper-case letter.

click_first_menu() – uses underscores.

Boolean getter member functions

It’s a good practice to prefix boolean getter functions with <is>.
e.g. isVisible(), isChecked(), isNumeric().

Getter member functions

Usually all getter functions should start with <get> prefix.
e.g. getLocalDate(), getMonth(), getDayOfMonth().

Setter member functions

Usually all setter functions should start with <set> prefix.
e.g. setLocalDate(), setMonth(), setDayOfMonth().

Note: Getter/Setter functions should follow a strict guideline for Java Bean
classes.

1.4- Source Code Style Guidelines

1.4.1- Line Spacing

1- Batasi setiap baris di bawah 80 karakter.

2- Batasi panjang komentar hingga 70 karakter.

3 - Pertahankan ukuran tab sama dengan 4 spasi.

1.4.2- Blank Space

1.4.3- If/else

1.4.4- For Loop

Dalam rilis JDK 1.5, ada fitur baru yang diperkenalkan terkait dengan peningkatan
untuk loop. Dalam hal ini, indeks array tidak diperlukan untuk pengambilan elemen
array.
1.4.5- While

1.4.6- Do…While Loop

1.4.7- Switch
1.4.8- Try/Catch/Finally

Pernyataan try-catch juga dapat diikuti oleh finally, yang dieksekusi terlepas dari status
eksekusi.
1.5- Comments

Here are the Java coding guidelines for quality comments.

1- Gunakan komentar sebelum deklarasi antarmuka, class, fungsi anggota, dan bidang.
Gunakan format Javadoc untuk berkomentar.
2- Terapkan komentar gaya-C untuk menguraikan kode yang tidak lagi berlaku.
3- Batasi komentar pada satu baris untuk fungsi anggota, bagian kode, dan deklarasi
variabel sementara.
4- Tulis komentar untuk meningkatkan kejelasan dan keterbacaan kode.
5- Jangan menambahkan informasi rangkap saat memberikan komentar.
6- Batasi panjang Komentar hingga 70 karakter per baris.

In Java, there are four ways of adding comments :

1.6- Standard Java Coding Conventions

1.6.1 – Deklarasi

1- Batasi satu deklarasi per baris untuk objek dan variabel.

2- Hindari menyatakan jenis berbeda dari garis yang sama.
3- Tetapkan nilai default untuk variabel lokal pada saat deklarasi.
4- Semua deklarasi di awal blok.
5- Jangan menggunakan deklarasi yang menimpa variabel lain yang memiliki nama identik.
6- Pastikan untuk menghilangkan peringatan jika ada.
1.6.2- Statements

1- Tuliskan hanya satu pernyataan per baris.

2- Jangan menginisialisasi lebih dari tiga variabel dengan koma di dalam lingkaran "untuk".
3- Jangan lupa untuk mengakhiri sakelar dengan pernyataan istirahat.
4- Pastikan pernyataan switch harus memiliki case standar.
5- Jangan memasang kabel nomor apa pun dalam kode, gunakan Makro untuk menentukan
konstanta.
6- Saat membandingkan selalu pertahankan konstanta di sisi kiri untuk menghindari tugas
yang tidak terduga.
7- Saat kembali dari suatu fungsi, ikuti pendekatan keluar tunggal dan tunggal.
8- Jadikan untuk memeriksa nol saat mengakses objek atau struktur data apa pun.
9- Batasi no. argumen ke lima untuk fungsi dan metode.
10- Juga, jangan memperpanjang no. karakter dari 80 karakter per baris.

1.6.3- Import Declaration

1- Mulailah pernyataan impor mulai dari kolom pertama dan gunakan satu spasi untuk
memisahkan kata kunci <import> dari nama package.
2- Kelompokkan semua pernyataan impor menggunakan nama package.
3- Gunakan baris kosong untuk memisahkan kelompok pernyataan impor.
4- Urutkan pernyataan impor sesuai urutan kamus.
 5- Mencegah penggunaan pernyataan impor terbuka seperti <import java.io. *;> Karena
akan menyebabkan impor yang tidak digunakan.

1.6.4- Blank Spaces

1.6.4.1- Adopt blank space Reject tabs

1.6.4.2- Avoid using blanks

1- Antara nama fungsi dan tanda kurung pembuka.

2- Sebelum atau sesudah operator "." (Dot).
3- Antara operator unary dan operan.
4- Antara pemain dan ekspresi.
5- Setelah tanda kurung buka atau sebelum tanda kurung tutup.
6- Setelah braket kuadrat pembuka "[" atau sebelum braket kuadrat penutup "]".
7- Jangan gunakan karakter khusus seperti umpan formulir atau spasi mundur.
1.6.5- Indentation

Indentasi garis selalu 4 spasi untuk semua level indentasi. Anda dapat indent
menggunakan tab (yang harus Anda hindari) untuk mengurangi ukuran file. Namun,
Anda tidak boleh mengubah pengaturan tab keras untuk mencapai ini. Mereka harus
diatur ke delapan ruang.

1.6.6- Continuation Lines

Baris harus dibatasi hingga 80 kolom kecuali untuk pengkodean non-ASCII. Jika mereka
menggunakan lebih dari 80 karakter, maka bagi menjadi satu atau lebih garis kelanjutan.
Semua garis kelanjutan harus disejajarkan dan lekuk dari baris pertama pernyataan.
Jumlah lekukan tergantung pada jenis pernyataan. Aturan lekukan yang sama harus Anda
ikuti untuk blok bersarang seperti <try ... catch>, <switch ... case> atau loop. Lihat contoh
di bawah ini.

1.6.7- Member documentation comments

1.6.8- Class and instance variable field declarations

1.7- Exception handling