Menulis Kode Program Agar Lebih Mudah Dimengerti


Bagaimana aktivitas coding sobat koci saat ini? Bagi sebagian orang berkenalan dengan bahasa program dan algoritma merupakan  suatu tantangan tersendiri. Mulai dari mengenal variabel, method, manual book dan bagaimana penulisan kode nya pun menjadi hal yang tidak bisa dilewatkan. Karena penulisan kode program pun ternyata mencerminkan bagaimana seorang programmer itu bekerja.

Terkadang ada satu hal yang perlu sobat koci pikirkan ketika menulis kode program (coding). Misalnya saja bagaimana jika orang lain ingin menggunakan kode program yang sobat koci tulis? Apakah mereka akan kebingungan atau tidak? Atau jika ternyata kode program yang sobat koci buat ternyata memiliki kode yang banyak dan sobat koci sudah lama tidak membukanya. Ketika sobat koci ingin mempelajarinya kode nya kembali, apakah sobat koci tidak kebingungan terkait kode tersebut, mulai dari hal kecil seperti  variabel hingga Algoritma. Tentunya ini akan merepotkan sobat koci bukan?

Untuk itu diperlukan bagaimana cara melakukan penulisan kode yang baik sehingga sekali jalan, sobat koci maupun orang lain bisa menggunakan kode program kita. Tidak perlu banyak langkah merepotkan untuk melakukannya, hanya butuh beberapa kemauan untuk menuliskannya di sisi kode.

Beginilah caranya:

Penamaan Variabel

Penamaan variabel terkadang menjadi hal yang mempengaruhi aktifitas coding sobat koci. Bagaimana tidak? Terkadang penamaan Variabel merupakan nama yang terlintas sejenak dalam pikiran Anda misalkan saja “data1“. Tapi pernahkah sobat koci memikirkan,  ketika menggunakan nama tersebut kebanyakan orang lain tidak akan memahaminya secara langsung. Apalagi ditambah dengan kurangnya dokumentasi pada hasil penulisan kode program.

Tidak hanya masalah penulisan variabel, hal ini berlaku pula saat sobat koci melakukan penulisan method ataupun class dari sebuah bahasa pemrograman. Ada baiknya penulisan method ataupun variabel menggambarkan inisialisasi dari fungsi tersebut. Misalkan saja untuk menuliskan nilai “rata-rata” tuliskan menjadi “Average“.

Reuse dan Modularity

Salah satu ide buruk adalah menumpuk banyak baris kode menjadi satu fungsi atau method. Kebiasaan kurang baik ini, jika dilanjutkan secara terus menerus akan menimbulkan kebingungan kepada sobat koci sendiri maupun orang lain yang menggunakannya. Mungkin saat ini sobat koci masih memahami setiap alur dari tiap method yang dibuat, tapi siapa tahu sobat koci akan membukanya tiga bulan atau enam bulan kedepan. Apakah sobat koci yakin masih mengingatnya dengan baik?

Selain itu, penerapan modularity juga akan memudahkan Anda untuk melakukan perbaikan ataupun optimisasi dari program yang sobat gunakan. Misalkan saja sobat koci membutuhkan perbaikan dari satu method, maka sobat koci tidak perlu melakukan perbaikan dari seluruh program milik sobat tapi hanya terbatas pada method yang menurut sobat koci butuh dioptimalisasi dengan lebih baik

Komentar

Penggunaan komentar hendaknya memiliki kesesuaian dan mencukupi kebutuhan sesuai baris kode yang sobat miliki. Misalkan saja pada sebuah variabel yang memang memiliki kompleksitas ataupun pada penggunaan yang tidak biasa. Jika sobat koci menggunakan komentar terlalu banyak, bagi sebagian orang terkadang hal ini akan lebih terkesan bertele – tele. Selain itu, fungsi lain dari adanya komentar dalam sebuah baris kode adalah menjelaskan bagaimana sebuah kode itu berkerja. Sehingga secara tidak langsung sobat koci dapat memberikan pemahaman kepada orang yang menggunakan kode program sobat, Mengapa sobat koci memilih variabel tersebut, mengapa sobat koci menggunakan Algoritmanya dan lain sebagainya.

Mengutip dari codinghorror, beberapa aturan sederhana dalam penggunaan komentar yaitu :

  • Gunakan jarak proporsional antara komentar dan kode yang sobat komentari. Maksud “jarak proporsional” adalah baris kode yang dikomentari tidak terlalu jauh ataupun tidak terlalu banyak.
  • Usahakan untuk tidak memberikan informasi yang sama pada sebuah komentar

Formatting

Seperti kita ketahui pada beberapa bahasa pemrograman, semicolon “;” merupakan tanda dari sebuah perintah di akhiri. Dengan adanya tanda tersebut bukan berarti sobat harus menjadikan semua kode menjadi satu baris, meskipun bisa dilakukan namun bukankah hal itu akan menjadikan tampilanya tidak lagi rapi dibandingkan dengan beberapa pemformatan atau penataan. Beberapa IDE telah memberikan shortcut secara otomatis untuk melakukan pemformatan pada hasil penulisan code Anda. Misalkan saja pada netbeans Anda bisa menggunakan shortcut Shift + ctrl + F untuk melakukannya.

Penulisan kode sobat koci pun kini akan lebih rapi sekaligus lebih mudah dipahami orang lain. tidak hanya itu, sobat koci pun juga tidak perlu repot menjawab segala pertanyaan karena segala hal telah sobat tuliskan pada bagian dokumentasi. Kegiatan ini sebenarnya tidak terlepas dari kebiasaan sobat saat melakukan aktifitas tersebut. Sobat koci mungkin memiliki langkah lebih baik saat melakukan aktifitas menuliskan kode, maka jangan ragu untuk berbagi pada pembaca lain lewat kolom komentar. Selamat mencoba!



Gambar dari : Richard di flickr, Elliot Cable di flickr.
Referensi :


Media informasi IT online kota cirebon, tempat berbagi informasi seputar dunia IT terbaru dengan konten berkualitas yang menginspirasi dan menambah wawasan masyarakat luas khususnya warga cirebon tentang dunia teknologi informasi.

Share this

Artikel Liyane

Previous
Next Post »