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;