Panduan Tata Cara Penulisan Kode Program Java Dan Dokumentasinya

Panduan Tata Cara Penulisan Kode Program Java Dan Dokumentasinya

Panduan Tata Cara Penulisan Kode Program Java Dan Dokumentasinya - Sama seperti saat kita menulis artikel, atau apapun juga, penyampaian yang jelas tentunya akan memudahkan para pembaca menangkap isi dari tulisan kita, demikian juga dengan coding Java. Pada pembahasan kali ini adalah mengenai gaya penulisan program Java dan dokumentasinya, yang memiliki 2 tujuan dasar yaitu :

• Membantu programmer mencegah error dalam pemrograman
• Membuat program menjadi mudah dibaca

Gaya penulisan program ini sebenarnya lebih kepada penampakan visual, bagaimana tanggapan atas kode yang kita tulis bila terlihat oleh mata kita ataupun oleh orang lain.

Suatu program dapat saja ditulis dalam satu baris, dan dapat di compile serta dijalankan dengan baik, namun apakah kode program itu mudah dibaca?

Mungkin saja orang yang melihat kode kita atau kita sendiri yang menulisnya merasa kesulitan saat melakukan penelusuran ulang terhadap kode program yang sudah kita buat, karena disamping kode programnya sulit, ditambah dengan penulisan kodenya yang amburadul.

Sedangkan dokumentasi lebih ke pemberian keterangan terhadap kode program, seperti single line komentar ataupun multiline komentar.

A. Tata cara pemberian komentar dalam program Java

Terdapat 2 tujuan pemberian komentar dalam kode pemrograman Java, terutama pada rangkaian kode program yang panjang yaitu:

• Memberikan keterangan terhadap suatu tujuan penulisan kode dengan jelas.
  Kode yang diberi keterangan mengenai tujuan penulisannya akan memudahkan kita menelusuri algoritma program yang kita buat. Jadi buatlah komentar dengan jelas.
• Penulisan komentar tidak menyulitkan pembacaan kode.
  Komentar yang diberikan harus sebisa mungkin tidak membuat program menjadi sulit dibaca, atau seperti bertumpang tindih. Memberi warna berbeda pada teks komentar juga merupakan hal yang bagus.

Terdapat 3 jenis komentar pada coding Java, yaitu :

1. Komentar single line, menggunakan tanda //
   Format : // teks
2. Komentar blok, diawali dengan tanda /* dan diakhiri dengan tanda */
   Format : /*
                 * teks
                 */
3. Komentar dokumentasi, ini adalah komentar spesial yang mengacu pada komentar javadoc. Komentar ini dapat diekstrak melalui file HTML menggunakan perintah javadoc pada JDK.
   Komentar ini diawali dengan tanda /** dan diakhiri dengan tanda */. Komentar ini bertujuan untuk menjelaskan mengenai keseluruhan class, method, konstruktor, interfaces, dan fields.
   Format : /** 
                 * teks
                 */

Contoh penulisan komentar :

/**
* Program SelamatDatang
* Menampilkan String "Selamat datang di pemrograman Java!" 
  pada output standar
* @author  Nazia
* @version 1.0
* @di buat pada 14-10-2015
*/
public class SelamatDatang {
    public static void main(String[] args) {
        /* Menampilkan "Selamat datang di pemrograman Java!" 
         * pada output standar 
         */
        System.out.println("Selamat datang di pemrograman Java!");
    } //Akhir dari main method
} //Akhir dari class SelamatDatang

B. Tata cara penggunaan indentasi dan spasi yang tepat

Dalam dunia penulisan, pengertian indentasi adalah bagian paragraf yang menjorok ke dalam. Penggunaan indentasi yang tepat juga diperlukan dalam penulisan program Java.

Sementara spasi dikenal juga dengan jarak, baik itu jarak tiap karakter ataupun jarak antara satu baris dengan baris lainnya.

a. Dibawah ini adalah contoh yang buruk :

public class Test {
public static void main(String args []){
System.out.println(3+4*4);
}
}

b. Sementara di bawah ini adalah contoh yang bagus, misalnya:

public class Test {
    public static void main(String args []){
           //Komentar
           System.out.println(3 + 4 * 4);
    }
}

Sebenarnya ini tergantung pada kita, bagaimana agar caranya kode yang kita buat itu mudah dan enak dibaca.

C. Gaya Menulis Blok Coding Java

Blok adalah kumpulan atau grup dari suatu pernyataan yang berada didalam tanda kurung kurawal atau { }.

{pernyataan}

Terdapat dua gaya dalam penulisan pada pemrograman Java ini, yaitu :

• Gaya penulisan next-line
• Gaya penulisan end-of-line

a. Contoh gaya penulisan next-line :

public class Test
{
    public static void main(String args [])
  
    {
        System.out.println(3 + 4 * 4);
    }
   
}

b. Contoh gaya penulisan end-of-line

public class Test {
   
    public static void main(String args []){
        System.out.println(3 + 6 * 7);
   
    }
}

Masing-masing gaya tersebut memiliki keunggulannya tersendiri, untuk gaya penulisan next-line maka program mudah dibaca, sementara gaya penulisan end-of-line, akan lebih menghemat ruang dan mencegah dari kesalahan kecil, Java API source code juga menggunakan gaya penulisan ini.

Namun satu hal yang pasti, tidak disarankan untuk mencampurkan kedua gaya penulisan ini dalam suatu program. Pilihlah salah satu mana yang sesuai dengan selera atau kebutuhan anda.

Jadi gaya penulisan kode program Java manakah yang anda pilih?