Panduan Tata Cara Penulisan Arahan Agenda Java Dan Dokumentasinya

Panduan Tata Cara Penulisan Kode Program Java Dan Dokumentasinya

Panduan Tata Cara Penulisan Kode Program Java Dan Dokumentasinya - Sama ibarat ketika kita menulis artikel, atau apapun juga, penyampaian yang terang tentunya akan memudahkan para pembaca menangkap isi dari goresan pena kita, demikian juga dengan coding Java. Pada pembahasan kali ini yaitu mengenai gaya penulisan aktivitas Java dan dokumentasinya, yang mempunyai 2 tujuan dasar yaitu :

• Membantu programmer mencegah error dalam pemrograman
• Membuat aktivitas menjadi gampang dibaca

Gaya penulisan aktivitas ini bersama-sama lebih kepada penampakan visual, bagaimana balasan atas instruksi yang kita tulis kalau terlihat oleh mata kita ataupun oleh orang lain.

Suatu aktivitas sanggup saja ditulis dalam satu baris, dan sanggup di compile serta dijalankan dengan baik, namun apakah instruksi aktivitas itu gampang dibaca?

Mungkin saja orang yang melihat instruksi kita atau kita sendiri yang menulisnya merasa kesulitan ketika melaksanakan penelusuran ulang terhadap instruksi aktivitas yang sudah kita buat, sebab disamping instruksi programnya sulit, ditambah dengan penulisan kodenya yang amburadul.

Sedangkan dokumentasi lebih ke derma keterangan terhadap instruksi program, ibarat single line komentar ataupun multiline komentar.

A. Tata cara derma komentar dalam aktivitas Java

Terdapat 2 tujuan derma komentar dalam instruksi pemrograman Java, terutama pada rangkaian instruksi aktivitas yang panjang yaitu:

• Memberikan keterangan terhadap suatu tujuan penulisan instruksi dengan jelas.
  Kode yang diberi keterangan mengenai tujuan penulisannya akan memudahkan kita menelusuri algoritma aktivitas yang kita buat. Kaprikornus buatlah komentar dengan jelas.
• Penulisan komentar tidak menyulitkan pembacaan kode.
  Komentar yang diberikan harus sebisa mungkin tidak menciptakan aktivitas menjadi sulit dibaca, atau ibarat 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, memakai tanda //
   Format : // teks
2. Komentar blok, diawali dengan tanda /* dan diakhiri dengan tanda */
   Format : /*
                 * teks
                 */
3. Komentar dokumentasi, ini yaitu komentar Istimewa yang mengacu pada komentar javadoc. Komentar ini sanggup diekstrak melalui file HTML memakai 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 tiba 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 tiba di pemrograman Java!"           * pada output standar           */         System.out.println("Selamat tiba 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 yaitu penggalan paragraf yang menjorok ke dalam. Penggunaan indentasi yang sempurna juga dibutuhkan dalam penulisan aktivitas Java.

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

a. Dibawah ini yaitu pola yang jelek :

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

b. Sementara di bawah ini yaitu pola 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 semoga caranya instruksi yang kita buat itu gampang dan lezat dibaca.

C. Gaya Menulis Blok Coding Java

Blok yaitu 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 mempunyai keunggulannya tersendiri, untuk gaya penulisan next-line maka aktivitas gampang dibaca, sementara gaya penulisan end-of-line, akan lebih menghemat ruang dan mencegah dari kesalahan kecil, Java API source code juga memakai 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.

Kaprikornus gaya penulisan instruksi aktivitas Java manakah yang anda pilih?

Bagikan Artikel ini