Clean Code/Kode Bersih

Clean Code

“So if you want to go fast, if you want to get done quickly, if you want your code to be easy to write, make it easy to read.”

Kelas PPL sempat diisi oleh seorang pembicara, yaitu mba Michaela Nathania, beliau adalah seorang Engineering Manager dari sebuah fintech startup bernama Cermati, pada saat itu beliau membawa materi clean code, jadi apa sih clean code itu? Dan bagaimana saya mengimplementasikannya pada kode yang saya buat, yuk mari kita simak!

Karakteristik-karakteristik pada clean code

1. Dapat dibaca oleh manusia — kode yang baik dan bersih dapat dimengerti dengan mudah oleh manusia, seperti membaca sebuah artikel, sebuah kode harus dapat dibaca dengan jelas.
2. Solid function — setiap fungsi hanya boleh melakukan 1 hal.
3. Don’t duplicate yourself — kode yang bersih tidak boleh ada fungsi yang terduplikat.

Bagaimana sih cara menulis clean code?

Nama

Orang bilang, nama adalah doa, nah dalam penulisan sebuah kode, nama adalah kunci dalam penulisan sebuah kode yang bersih, berikanlah nama yang berarti pada sebuah fungsi, variabel, maupun yang lain-lain.

Usahakan nama variabel sesuai isinya, contoh:

final List<String> myList = new List();final List<String> homeImageList = new List();
final scaffoldKey = GlobalKey<ScaffoldState>();
var utils = new Util()

homeImageList , scaffoldKey , dan utils memiliki makna yang berarti dan sesuai dalam kodingan Flutter yang saya buat.

Selain nama variabel, nama class juga harus diperhatikan, hindari penamaan class dengan kata kerja, harus merupakan kata benda, contoh:

class AboutPage extends StatelessWidget {
.
.
.
}
class HomePage extends StatelessWidget {
.
.
.
}
class SplashScreen extends StatefulWidget {
.
.
.
}

AboutPage , HomePage , dan SplashScreen menggunakan kata benda, menggambarkan bahwa class-class ini merupakan sebuah objek.

Lalu ada nama fungsi, nama fungsi sebaiknya menggunakan kata kerja, dan jelas, contoh

void initState() {
  super.initState();
  transitionToHome();
}
getScaffoldKey() {
  return scaffoldKey;
}

Lihat bagaimana semua fungsi di atas menggunakan kata kerja, menandakan fungsi tersebut melakukan suatu hal, dan hal yang dilakukan oleh fungsi tersebut harus dideskripsikan dengan benar.

Fungsi

Fungsi haruslah simpel, mereka harus didesain untuk melakukan hanya satu hal, dan fungsi yang baik tidak memiliki lebih dari tiga argumen.

Komentar

Jika kamu masih memerlukan komentar untuk menjelaskan kodemu, maka kodemu masih belum bisa dianggap bersih. Komentar hanya diperlukan untuk sesuatu yang menyangkut legalitas saja.

Itu hal-hal yang saya dapatkan dari kuliah tamu mba Michaela Nathania, saya berharap kode yang saya tulis selama PPL ini bisa sebersih dan seputih senyum merk pasta gigi, semangat PPL :)