Tips Penulisan Kode Pemrogaman Agar Mudah Dimengerti

Belajar coding merupakan aktifitas yang bisa dianggap gampang gampang susah. Bagi sebagian orang berkenalan dengan bahasa yang aneh dan algoritma merupakan tantangan tersendiri. Mulai mengenal variabel, method, manual book dan bagaimana penulisan pun juga hal yang tidak bisa dilewatkan begitu saja. Namun, Hal lain patut Anda pikirkan. Misalnya saja bagaimana jika orang lain ingin menggunakan kode program yang Anda tulis? Apakah mereka kebingungan atau tidak? Banyak pertanyaan akan diberikan kepada Anda perihal kode tersebut, terkait segala hal mulai dari hal kecil seperti variabel hingga Algoritma. Tentunya hal ini akan merepotkan Anda bukan?

Untuk itu diperlukan bagaimana cara melakukan penulisan kode yang baik sehingga sekali jalan, Anda maupun orang lain bisa menggunakan kode milik Anda. Tidak perlu banyak langkah merepotkan untuk melakukannya, hanya butuh beberapa kemauan untuk menuliskannya di sisi kode. Berikut diantaranya:

Penamaan Variabel

Penamaan variabel terkadang menjadi hal yang mempengaruhi aktifitas coding Anda. Bagaimana tidak? Terkadang penamaan Variabel merupakan nama yang terlintas sejenak dalam pikiran Anda misalkan saja “data1“. Tapi pernahkah Anda memikirkan,  ketika menggunakan nama tersebut kebanyakan orang lain tidak akan memahaminya secara langsung. Apalagi ditambah dengan kurangnya dokumentasi pada hasil penulisan kode Anda.
Tidak hanya masalah penulisan variabel, hal ini berlaku pula saat Anda 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 Anda sendiri maupun orang lain yang menggunakannya. Mungkin saat ini Anda masih memahami setiap alur dari tiap method yang dibuat, tapi siapa tahu Anda akan membukanya tiga bulan atau enam bulan kedepan. Apakah Anda yakin masih mengingatnya dengan baik?
Selain itu, penerapan modularity juga akan memudahkan Anda untuk melakukan perbaikan ataupun optimisasi dari program yang Anda gunakan. Misalkan saja Anda membutuhkan perbaikan dari satu method, maka Anda tidak perlu melakukan perbaikan dari seluruh program milik Anda tapi hanya terbatas pada method yang menurut Anda butuh dioptimalisasi dengan lebih baik

Komentar

Penggunaan komentar hendaknya memiliki kesesuaian dan mencukupi kebutuhan sesuai baris kode yang Anda miliki. Misalkan saja pada sebuah variabel yang memang memiliki kompleksitas ataupun pada penggunaan yang tidak biasa. Jika Anda 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 Anda dapat memberikan pemahaman kepada orang yang menggunakan kode Anda, Mengapa Anda memilih variabel tersebut, mengapa Anda menggunakan Algoritmanya dan lain sebagainya.

Mengutip dari codinghorror, beberapa aturan sederhana dalam penggunaan komentar Antara lain :

• Gunakan jarak proporsional antara komentar dan kode yang Anda 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 Anda harus menjadikan semua kode menjadi satu baris, meskipun bisa dilakukan namun bukannkah 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 Anda pun kini akan lebih rapi sekaligus lebih mudah dipahami orang lain. tidak hanya itu, Anda pun juga tidak perlu repot menjawab segala pertanyaan user karena segala hal telah Anda tuliskan pada bagian dokumentasi. Kegiatan ini sebenarnya tidak terlepas dari kebiasaan Anda saat melakukan aktifitas tersebut. Anda mungkin memiliki langkah lebih baik saat melakukan aktifitas menuliskan kode, maka jangan ragu untuk berbagi pada pembaca lain lewat kolom komentar. Selamat mencoba!