GAYA PENULISAN PROGRAM

 

Gaya Penulisan Program

Gaya penulisan program sangat penting untuk meningkatkan keterbacaan (readability), konsistensi, dan kemudahan debugging. Dalam aplikasi manajemen data siswa, penggunaan gaya penulisan yang baik akan membantu pengembang lain memahami kode dengan lebih mudah.

Berikut beberapa aspek penting dalam gaya penulisan Java:


1. Penulisan Nama Variabel, Method, dan Class

a. CamelCase untuk Variabel dan Method

  • Gunakan huruf kecil di awal, kemudian huruf besar di setiap kata baru (camelCase).
  • Contoh: namaSiswa, hitungRataNilai().

b. PascalCase untuk Nama Class

  • Gunakan huruf besar di setiap kata (PascalCase).
  • Contoh: DataSiswa, ManajemenSiswa.

c. Huruf Kapital untuk Konstanta

  • Gunakan huruf besar semua dengan underscore sebagai pemisah.
  • Contoh: MAX_NILAI, MIN_USIA.

Contoh Penulisan yang Baik

package com.manajemen.siswa;
public class DataSiswa { private String namaSiswa; // Variabel camelCase private int umurSiswa; public void setNamaSiswa(String namaSiswa) { // Method camelCase this.namaSiswa = namaSiswa; } public String getNamaSiswa() { return namaSiswa; } }

2. Indentasi dan Pemformatan Kode

Indentasi yang baik memudahkan pembacaan kode, terutama pada struktur seperti if-else, perulangan, dan method.

Contoh Indentasi yang Benar

package com.manajemen.siswa;
public class CekNilai { public static void main(String[] args) { int nilai = 80; if (nilai >= 75) { System.out.println("Lulus"); } else { System.out.println("Tidak Lulus"); } } }

Contoh Indentasi yang Buruk

package com.manajemen.siswa;
public class CekNilai { public static void main(String[] args) { int nilai = 80; if (nilai >= 75) { System.out.println("Lulus"); } else { System.out.println("Tidak Lulus"); }}}

❌ Indentasi tidak konsisten membuat kode sulit dibaca.


3. Penggunaan Keterangan (Komentar)

Komentar membantu menjelaskan kode tanpa mempengaruhi program.

a. Komentar Satu Baris (//)

Digunakan untuk memberi keterangan singkat.

int jumlahSiswa = 30; // Menyimpan jumlah siswa dalam kelas

b. Komentar Multi Baris (/* ... */)

Digunakan untuk penjelasan lebih panjang.

/*
Program ini digunakan untuk menghitung rata-rata nilai siswa. Input: Daftar nilai siswa Output: Nilai rata-rata */

c. Komentar Javadoc (/** ... */)

Digunakan untuk mendokumentasikan class atau method.

/**
* Method ini digunakan untuk menghitung rata-rata nilai siswa. * @param nilai1 Nilai ujian pertama * @param nilai2 Nilai ujian kedua * @return Rata-rata nilai siswa */ public double hitungRataNilai(double nilai1, double nilai2) { return (nilai1 + nilai2) / 2; }

4. Penggunaan Spasi dan Baris Kosong

Gunakan spasi dan baris kosong dengan bijak untuk meningkatkan keterbacaan kode.

Contoh yang Benar

package com.manajemen.siswa;
public class HitungNilai { public static void main(String[] args) { int nilaiTugas = 80; int nilaiUjian = 90; int rataRata = (nilaiTugas + nilaiUjian) / 2; System.out.println("Rata-rata nilai: " + rataRata); } }

Contoh yang Buruk

package com.manajemen.siswa;
public class HitungNilai { public static void main(String[] args) {int nilaiTugas=80;int nilaiUjian=90;int rataRata=(nilaiTugas+nilaiUjian)/2;System.out.println("Rata-rata nilai: "+rataRata);}}

❌ Kode terlalu padat dan sulit dibaca.


5. Pemisahan Kode ke Dalam Class

  • Pisahkan kode ke dalam beberapa class agar mudah dikelola.

Struktur Folder yang Baik

com.manajemen.siswa
│── MainApp.java │── model │ ├── Siswa.java │ ├── Guru.java │── service │ ├── SiswaService.java │── view │ ├── SiswaForm.java

Catatan

✅ Gunakan CamelCase untuk variabel & method, PascalCase untuk class, dan huruf kapital untuk konstanta.
✅ Gunakan indentasi yang rapi agar kode mudah dibaca.
✅ Gunakan komentar untuk dokumentasi kode.
✅ Tambahkan spasi dan baris kosong untuk meningkatkan keterbacaan.
✅ Pisahkan kode ke dalam class dan package sesuai fungsi.

Post a Comment

0 Comments