Dokumen tersebut memberikan tips-tips untuk membuat nama variabel, fungsi, kelas, dan paket yang baik dalam pembuatan kode program. Beberapa tips utama adalah menggunakan nama yang jelas maksudnya, hindari penggunaan encoding, gunakan kata benda untuk nama kelas dan verba untuk nama metode, serta tambahkan konteks yang bermakna.

1. Clean Code and
Design Pattern
Meaningful Names
By:
Adam Mukharil Bachtiar

2. CLEAN CODE
I like my code to be elegant and efficient. The
logic should be straightforward to make it hard
for bugs to hide, the dependencies minimal to
ease maintenance, error handling complete
according to an articulated strategy, and
performance close to optimal so as not to tempt
people to make the code messy with unprincipled
optimizations. Clean code does one thing well.
Sumber: Clean Code, Robert C. Martin
Bjarne Stroustrup
Founder of C++

3. Nama itu selalu ada di dalam kode
program dan bisa muncul dalam
bentuk variabel, nama fungsi,
argumen, class, dan packages.

4. Bad Code
Kode program tersebut untuk
apa? Berapa detik yang
dibutuhkan untuk paham maksud
dari program ini?

5. Clean Code
Nama fungsi sudah cukup
menggambarkan maksud
dari fungsinya. Nama
variabel lebih jelas.

6. Bagaimana menggunakan
konsep nama yang baik
dalam membuat kode
program?

7. Tips 1
Gunakan nama yang
Intention-Revealing

8. Do this: Instead of this:

9. Tips 2
Hindari Disinformation

10. Penggunaan nama yang
mengandung istilah di
pemrograman sebaiknya sesuai
dengan implementasinya.

11. Do this: Instead of this:
nameList = [’Adam’, ‘Budi’, ‘Vano’]
Catatan:
List dalam python diwakili dengan tanda [ ].
nameList = (’Adam’, ‘Budi’, ‘Vano’)
Catatan:
Tanda ( ) menandakan tipe SET di dalam Python.

12. Tips 3
Buat nama yang
Jelas Perbedaannya

13. Do this: Instead of this:
Catatan:
Penggunaan source dan dest (destination)
meningkatkan perbedaan dibanding
penggunaan a1 dan a2

14. Tips 4
Gunakan
Pronounceable Names

15. Seringkali programmer
membicarakan kode
program ketika sedang
istirahat ataupun mengobrol.

16. Do this: Instead of this:
Catatan:
Penggunaan nama yang mudah disebutkan
akan menolong programmer ketika
berdiskusi tanpa komputer.

17. Tips 5
Gunakan
Searchable Names

18. Penggunaan nama variabel
dengan satu karakter
biasanya menyulitkan
pencarian kode program.

19. Do this: Instead of this:
Catatan:
Nama variabel yang hanya satu karakter
akan muncul bersamaan dengan kode lain
yang mengandung karakter tersebut.

20. Tips 6
Hindari penggunaan
Encoding

21. Do this: Instead of this:
nama%20orang = [’Adam’, ‘Budi’, ‘Vano’]
Catatan:
Beberapa bahasa sangat strict dalam
penggunaan encoding
namaOrang = (’Adam’, ‘Budi’, ‘Vano’)
Catatan:
Variabel nama orang bisa bertukar dengan
nama_orang. Sesuaikan bahasa yang digunakan.

22. Do this: Instead of this:
Catatan:
Beberapa programmer biasanya
menambahkan imbuhan untuk penanda.

23. Do this: Instead of this:
interface IBangunDatar{
..
}
Catatan:
Penggunaan prefix I biasanya digunakan
programmer untuk membedakan interface
dengan abstract class pada Java.
interface BangunDatar{
..
}

24. Tips 7
Hindari penggunaan
Mental Mapping

25. Pengajar pemrograman
seringkali menanamkan
penggunaan variabel i dalam
struktur perulangan.

26. Tips 8
Gunakan kata benda untuk
nama kelas

27. Tips 9
Nama method harus
mengandung verb atau
verb-phrase

28. Mahasiswa
deleteMahasiswa
ControllerMatkul
MataKuliah
hapusMataKuliah
cetakReportSKS
Nama Class
Nama
Method

29. Tips 10
Pilih satu nama untuk
setiap konsep

30. Sebagai contoh untuk fungsi
ubah data, pilih satu nama baik
ubahData( ) atau editData( ) tapi
tidak keduanya.

31. Tips 11
Gunakan nama dari
Solution Domain

32. Penggunaan nama yang
familiar oleh Programmer
dapat membuat kode
program lebih dipahami.

33. antrianKeluhan ataukeluhanQueue?
Catatan: lakukan ini hanya jika ada istilah yang memang common di domain programming, selebihnya
gunakan problem domain

34. Tips 12
Tambahkan
Meaningful Context

35. Pahami Kode
Program Berikut!

36. Bandingkan kode
sebelumnya
dengan yang ini!