Menulis Baris Kode

Ada beberapa hal yang penting tercantum dalam script code. Berikut ini adalah rekomendasi dalam pembuatan dokumentasi script code. Dalam sebuah project, tiap file biasanya diberi keterangan mengenai file tersebut. Keterangan yang tercantum di antaranya adalah:

1. Nama pembuat dan identitas lain, seperti NIP /  NIM atau nomor identitas lain
2. Tujuan dari file tersebut dalam program
3. Jenis data yang digunakan
4. Cara kerja prosedur dan operasi yang dilakukan
5. Hal-hal yang mungkin ditanyakan oleh pembaca kode.

Misalnya, untuk dokumentas Java dan javascript:

/*

* Author: Dinni Hayyati (NIP: XXX)

* Terakhir update: 12-13-2020

* Keterangan: File ini berisi networking detail untuk multiplayer.

* Cara kerjanya adalah……….

*/

Di samping itu, ada beberapa hal yang perlu diperhatikan untuk mempermudah pemeliharaan dan pengembangan selanjutnya, yaitu:

1. Kerapihan
2. Mudah dibaca
3. Konsistensi, misalnya dalam penulisan variabel dan prosedur. Pada Java, variabel biasanya ditulis dengan satu kata yang ditulis semua dalam huruf kecil, misalnya:

panjang = 10;

lebar = 15;

Untuk dua atau lebih kata, biasanya ditulis dengan camels tyle. Camel style, yaitu menggabungkan dua atau lebih kata di mana kata pertama ditulis dalam huruf kecil dan awal huruf untuk kata kedua dan seterusnya ditulis dengan huruf kapital, misalnya:

volumeKubus = 12;

jarijariLingkaran = 3.0;

Untuk nama Class dalam java, biasanya ditulis dengan huruf kapital pada awal huruf, misalnya

User

FirstPlayer

Untuk nama konstanta, diberi huruf kapital, seperti:

RADIAN = 3.14;

ANGKA_PEMBAGI = 10;

Gunakan naming convention yang sama dalam satu proyek. Gunakan juga kata yang sama dalam menjelaskan variabel yang sama.

4.  Tidak perlu memberi keterangan untuk sesuatu yang sudah jelas.

5. Terorganisir. Nama pembuat dan keterangan biasanya dicantumkan di awal baris code, sedangkan keterangan lain untuk prosedur dan variabel ditulis di awal prosedur atau di atas/samping variabel. 

6. Nama variabel, prosedur, method, dan lain-lain harus menggambarkan tujuan dari variabel atau prosedur tersebut. Hindari penggunaan huruf untuk variabel. Misalnya, dalam menuliskan variabel “nama pemain”.

namaPemain = “”; (jelas dalam penulisan)

np = “”; (tidak jelas maknanya)

 

7. Hindari penggunaan kata yang panjang untuk nama. 

8. Tulis sesederhana mungkin. 

Referensi: 

Peter Schacte. Project Coding Guidelines. 2014. Declarative Programming.