Pedoman Penulisan Program Java

Panduan Penulisan Program

1.       Penamaan

1.1. Gunakan nama yang memiliki makna

Gunakan nama yang cukup deskriptif (jelas) untuk semua identifier (nama kelas, variabel dan method). Hindari ambiguitas. Hindari penyingkatan. Berdasarkan standar penulisan, method mutator diberi nama setSesuatu(...), method aksesor diberi nama getSesuatu(...), method aksesor yang mengembalikan nilai boolean diberi nama isSesuatu(...). Sebagai contoh:

setName(String name), getName(), isEmpty().

1.2. Nama kelas dimulai dengan sebuah huruf kapital.

1.3. Nama kelas menggunakan nama benda tunggal.

1.4. Nama method dan variabel dimulai dengan huruf kecil.
Menurut standar penulisan, semua nama kelas, method dan variabel yang terdiri dari gabungan beberapa kata, menggunakan huruf kapital untuk memulai kata selanjutnya untuk lebih memperjelas ketika dibaca. Sebagai contoh :  jumlahPersediaanBarang.

1.5. Konstanta ditulis secara keseluruhan dengan huruf KAPITAL 

Konstanta biasanya ditulis menggunakan underscore untuk kata-kata gabungan. Misal: NILAI_MAKSIMUM

2.       Tampilan

2.1. Satu identasi terdiri dari empat spasi 

2.2. Semua statement dalam blok yang sama memiliki identasi yang sama

2.3. Tanda kurung kurawal penanda blok kelas dan method berada pada baris tersendiri dan memiliki identasi yang sama, sebagai contoh:  

 public class Employee

 {

         public int getAge()

         {

               statements

         }  
  }

2.4. Untuk blok-blok kode yang lain (mis: perulangan, percabangan), kurung kurawal dibuka pada akhir baris.

Semua blok dibuka oleh kurung kurawal di akhir baris tempat keyword blok tersebut dibuat. Kurung kurawal penutup berada di baris terpisah, segaris dengan keyword blok tersebut dibuat. Sebagai contoh: 

      while(condition) {                    statements

                }           if(condition) {           statements

     }      else {              statements      }

2.5 Selalu gunakan kurung kurawal untuk mengontrol struktur kode.

Kurung kurawal selau digunakan dalam percabangan (if-statement) dan perulangan (loop) meskipun blok tersebut hanya berisi satu baris perintah.

2.6 Berikan spasi sebelum membuka kurung kurawal untuk mengatur struktur blok

2.7 Berikan spasi di sekitar operator

2.8 Berikan baris kosong antara method (dan konstruktor)

Berikan baris kosong untuk memisahkan bagian kode secara logis. Sebagai contoh untuk bagian logis yang sama dengan yang lainnya di dalam sebuah method terpisah oleh sebuah baris kosong.

Sebagai contoh:

      public double getBalance(double principal, double rate, int time){              double balance = principal;

        

            balance = principal * (1 + (rate * time) / 100);

        

            return balance;

     }

3.       Dokumentasi 

3.1. Setiap kelas memiliki kometar/penjelasan kelas tersebut di atasnya Komentar kelas paling tidak terdiri dari :

•    deskripsi umum kelas tersebut

•    nama penulis (author)

•    nomor versi kelas tersebut

Setiap individu yang berkontribusi dalam pembuatan kelas tersebut harus dinyatakan sebagai penulis atau setidaknya diberi kredit yang sesuai.

Nomor versi dapat berupa nomor sederhana, tanggal ataupun format lain. Poin pentingnya adalah pembaca dapat mengenali bila ada dua versi yang berbeda dari kode tersebut, dan bisa menentukan yang mana yang lebih baru.

3.2. Setiap method harus memiliki komentar 

3.3. Komentar haruslah berupa komentar Javadoc 

Komentar kelas dan method harus dikenal oleh Javadoc. Dengan kata lain: komentar harus dimulai dengan simbol komentar /**

Contoh komentar untuk kelas:

      /**

*  Kelas ini memodelkan pekerja di suatu perusahaan secara umum.      * Kelas ini selanjutnya akan diturunkan menjadi kelas-kelas   * yang lebih spesifik.

*   

*  @author Nobita Nobi      * @version 2011.09.20

*    */

      public class Employee

      {

      ....

      }

Contoh komentar untuk method:

/**

*  Method untuk mengubah nilai umur dari pekerja

*  @param age umur pekerja

*/

public void setAge(int age){        this.age = age;

}

      /**

*  Method untuk menghitung hasil investasi dengan perhitungan bunga sederhana

*  @param principal nilai awal modal

*  @param rate persen bunga tahunan (dalam bentuk desimal)

*  @param time lama waktu investasi

*  @return hasil investasi setelah modal dikalikan dengan bunga

      */

     public double getBalance(double principal, double rate, int time){              double balance = principal;

            balance = principal * (1 + (rate * time) / 100);

       

            return balance;

      }

3.4. Berikan komentar kode (hanya) ketika diperlukan

Komentar dalam kode harus diberikan ketika kode program tidak jelas atau sulit untuk dimengerti (di sisi lain juga dianjurkan untuk membuat kode program sejelas mungkin ataupun semudah mungkin untuk dimengerti), dan juga untuk memperjelas sebuah method. Jangan berikan komentar terhadap perintah-perintah yang cukup jelas – asumsikan pembaca kode anda mengerti Java!

4.       Aturan Lain

4.1. Urutan pendeklarasian : field, konstruktor, method 

Elemen dari pembuatan kelas muncul (bila ada) dalam urutan sbb: package statement; import statement; komentar kelas; nama kelas; definisi field; konstruktor; method. 

4.2. Field boleh tidak public (pengecualian untuk field bertipe final). 

4.3. Selalu gunakan access modifier 

Nyatakan semua field dan method sebagai private, public ataupun protected. Jangan gunakan akses default.

4.4. Import kelas-kelas secara terpisah

Pernyataan import secara eksplisit untuk setiap kelas lebih disukai dibandingkan meng-import seluruh package. Contoh :

      import java.util.ArrayList;   import java.util.HashSet;

             

            lebih baik dibandingkan

       

      import java.util.*;

4.5. Selalu buat sebuah konstruktor (walaupun body konstruktor tersebut kosong).

4.6. Selalu buat pemanggilan konstruktor superclass. 

Di dalam konstruktor subclass, jangan bergantung pada pemanggilan konstruktor superclass secara otomatis. Panggilah super(...) secara eksplisit, meskipun program anda tetap akan berjalan tanpa pemanggilan tersebut.

4.7. Inisialisasikan semua field di dalam konstruktor 

* dikutip sepenuhnya dari document yang diberikan dosen yang bersangkutan. Dapat di DOWNLOAD DISINI.

Terima kasih, Semoga Bermanfaat ^_^

by : akachopa