Formatting Code - APTIKOM
Transcript of Formatting Code - APTIKOM
Clean Code & Design PatternFormatting Code
Isi material di slide ini disadur dari berbagai sumber.Slide ini hanya dipergunakan untuk tujuan pengajaran.
Adam Mukharil Bachtiar
Clean Code Pada Code FormattingDalam penulisan code, format atau tata penulisan perlu diperhatikan, di mana
hal tersebut mencakup :
1 Vertical Formatting
2 Horizontal Formatting
Tujuan Code FormattingBukan sekedar “bekerja”, tapi juga terpelihara
Vertical Formatting
Vertical FormattingTata penulisan vertikal mencakup :
1 Opennes Between Concepts
2 Density
3 Distance & Ordering
Vertical Opennes Between ConceptsMakna baris kosong pada penulisan code. Karena setiap baris ekspresi dan
kumpulan garis memiliki makna yang berbeda.
Struktur program akan sulit dibaca karena pendefinisian atribut, pendefinisian method,danpemanggilan package lain tidak diberi jarak.1
Membuat pusing saat mata tidak terlalu fokus memperhatikan struktur program2
Program lebih terstruktur dengan memisahkan sintaks berdasarkan kegunaannya1
Program akan lebih cepat untuk dipahami2
Vertical DensityPenggunaan baris kosong sebagai pemisah code berdasarkan kegunaannya.
Penggunaan komentar yang tidak diperlukan1
Membuang-buang ruang kosong2
Struktur class lebih mudah untuk dibaca1
Struktur class dapat terlihat seluruhnya tanpa harus melakukan scroll2
Vertical DistancePenempatan definisi variabel, atribut, dan method yang tertata untuk menghindari
alur penggunaan variabel, atribut, dan method yang membingungkan.
Vertical Distance Rule
1 Deklarasi variabel disarankan dekat dengan penggunaannya.
2 Instansiasi variabel/atribut dilakukan pada bagian Class yang paling
atas.
3 Fungsi yang saling bergantungan di simpan berdekatan, fungsi yang
menjadi pemanggil fungsi lain di simpan di atas deklarasi fungsi yang
dipanggil (Ordering).
private static void readPreferences() { InputStream is= null; try {
is= new FileInputStream(getPreferencesFile()); setPreferences(new Properties(getPreferences())); getPreferences().load(is);
} catch (IOException e) { try {
...
Vertical Distance SampleDeklarasi Variable
public class TestSuite implements Test {
...private String fName;private Vector<Test> fTests= new Vector<Test>(10);...
Vertical Distance SampleInstansiasi Variable/Atribut
public class WikiPageResponder implements SecureResponder { ...
public Response makeResponse(FitNesseContext context, Request request) throws Exception {String pageName = getPageNameOrDefault(request, "FrontPage");loadPage(pageName, context); ...
}
private String getPageNameOrDefault(Request request, String defaultPageName) {...
}
Vertical Distance SampleFungsi yang Saling Bergantungan
Horizontal Formatting
Horizontal FormattingTata penulisan horizontal mencakup :
1 Alignment
2 Indentation
Horizontal AlignmentCukup gunakan alignment yang sewajarnya.
Alignment untuk nama atribut terlalu berlebihan 1
Alignment di atas menjauhkan nama atribut dari objek yang diinstansiasinya2
Gunakan alignment yang sewajarnya1
Pembaca dapat dengan mudah melihat objek yang diinstansiasi2
Horizontal IndentationJaga informasi yang terdapat dalam code dengan memberikan indentasi yang
jelas di setiap blok.
Struktur program tidak terbaca1
Maintenance akan sulit untuk dilakukan2
Struktur program mudah untuk dibaca1
Tidak membuat sakit kepala2
Tolong kamu camkan itu!!!Format atau tata penulisan dalam menulis code ditentukan
oleh tim. Sehingga kerja sama dan komitmen antar anggota
tim sangat berpengaruh untuk membuat code yang
maintainable.
Terima KasihPelatihan Java Intermediate – Clean Code pada Code Formatting sudah selesai. Hari ini hanya awal dari hal yang lebih besar di depan sana.