Tips Berkomentar Ria Di Kodingan

Setiap kerja tim, apalagi programmer, dituntut untuk selalu cepat dan efisien. Tidak ada jambak-menjambak rambut, tidak ada main salah-salahan, dan tidak ada yang mau enaknya sendiri.

Terkhusus programmer, apalagi kerja tim yang sharing kodingan, pastinya harus mengerti kodingan satu sama lain. Ditambah lagi, ada beberapa tim yang memang masih tergolong junior untuk mengerjakan tugas-tugas produksi. Maka dari itu, sudah menjadi tugas senior untuk membuat para junior paham dan tidak membuang waktu lagi untuk mencari-cari kodingan yang dimaksud.

Apa yang harus dilakukan? Orang-orang pastinya akan selalu dan selalu memberikan banyak komentar pada kodingan mereka, termasuk saya. Bahkan para junior pun seharusnya belajar untuk selalu memberikan komentar pada setiap program yang mereka tulis. Karena komentar adalah sebuah fitur untuk menuliskan apapun dengan sebab compiler akan mengacuhkan komentar.

Tapi… tak jarang kodingan yang muncul terkadang justru jadi saingan berita politik karena terlalu banyak komentar.

Tidak betah dengan akibat yang seperti ini, saya membuat beberapa tips bagi diri saya yang akan saya tulis di sini, mengenai manajemen komentar pada blog.


  • Komentar dapat jadi bookmark

Saya pernah diajari oleh seseorang beberapa tahun lalu, jika ada task/tugas yang masih menunggu untuk dikerjakan, atau ada kodingan yang masih harus dilengkapi di baris tertentu, maka dapat ditandai dengan komentar.

Komentar untuk bookmarknya harus didahului dengan standar yang memiliki tiga macam, yaitu: TODO, HACK, dan BUG.

  1. TODO, jika masih ada yang harus diimplementasi pada baris kode tersebut.
  2. HACK, jika pada kode tersebut masih ada tambalan untuk jalan pintas dengan alasan, “yang penting programnya jalan dulu, tambal dulu saja kodenya.”
  3. BUG, jika dibaris tersebut diasumsikan atau bahkan benar-benar menimbulkan bug pada program, namun penyelesaiannya masih ditunda karena ada prioritas lain.

Contoh:

// TODO: Menambahkan fungsi untuk menampilkan foto pada website
function TampilFoto (URLFoto) {
     // Masih kosong
}

  • Bukan hanya novel, kodingan pun punya kisah

Jangan mentang-mentang saya bandingkan dengan novel, komentar programnya ditulis hingga ribuan baris. Ini kodingan btw, bukan Siti Nurbaya.

Kodingan harus diberikan komentar pada setiap blok tertentu karena pastinya kita ingin paham akan “mengapa saya harus tambahkan kode ini?”, atau “Kapan terakhir kode ini ditambahkan?”

Cukup tuliskan tanggal diubah, dan oleh siapa diubahnya pada setiap blok kodingan (misalnya dalam sebuah fungsi) untuk tahu bagaimana kodingan itu bekerja. Dan sedikit dianjurkan agar dituliskan kapan terakhir kali blok kodingan itu diubah beserta detailnya mengapa diubah agar menjadi dokumentasi sendiri.

Oh, komentar juga dapat menjadi identitas sendiri di setiap awal file kodingan mengenai paparan singkat isi dari file tersebut, beserta sejarah dibuatnya.

Contoh:

// DIUBAH 05/08/2016, ANANDASTOON: Mengganti isi dari variabel url agar dapat beradaptasi dengan domain apapun
function TampilFoto (URLFoto) {
     // Blok kodingannya
}

  • Sebagai algoritma awal, dan analisa

Mengerjakan sesuatu yang baru dan bertahap itu benar-benar merepotkan bukan? Misalnya, kalian disuruh untuk membuatkan sebuah slide tentang foto-foto yang telah disimpan di database. Membayangkan hal tersebut bagaimana tekniknya saja sudah bikin malas, dan kalian mungkin dipaksa untuk mengerjakannya dalam lingkup deadline.

Tenang, The power of commentary sangat diperlukan di sini. Cukup breakdown satu-satu algoritmanya lewat komentar, kemudian kalian dapat mulai menuliskan kodingan-kodingan tepat di bawah komentar tersebut.

Contoh:

// TODO: Menampilkan slideshow foto dari database
// 1. Buat query untuk ambil datanya.
// 2. Render data di HTML menggunakan div
// 3. Masukkan javascript untuk membuatnya menjadi slideshow

Kemudian kalian sempurnakan:

// TODO: Menampilkan slideshow foto dari database
// 1. Buat query untuk ambil datanya.
$query = mysqli_query(...);
// 2. Render data di HTML menggunakan div
while ($hasil = mysqli_fetch_assoc(...)) {
     //Render ke div
} 
// 3. Masukkan javascript untuk membuatnya menjadi slideshow
<script>
//..blah, blah, blah
</script>

Yup, benar-benar dapat membuat kerjaan selesai sebelum deadline berakhir, kemudian kalian tinggal dipromosikan oleh atasan kalian, deh.


  • Menjaga data jika suatu saat diperlukan

Algoritma kalian ternyata salah dan harus diubah? Ingin dihapus semua kodingan yang telah kalian siang malam buat? Jika suatu saat ternyata kodingan kalian yang paling awal yang benar bagaimana? Harus buat ulang lagi begitu karena yang sebelumnya sudah kalian hapus? Capede…

Jadikan saja komentar blok kode kalian itu. Jadi jika suatu saat bos dengan mudahnya berubah pikiran dan minta dikembalikan lagi ke semula, kalian tidak perlu lagi repot-repot mencari dukun untuk meneluh bos kalian hingga dia sungkeman memohon ampunan di kaki kalian. Karena, kalian hanya tinggal meng-uncomment (bahasa Indonesianya apa ya?) kodingan kalian dan… happy ending.

Contoh:

// Berikut adalah kodingan yang masih sayang dibuang
/* Dikomentar saja blok kodenya
function TampilFoto (URLFoto) {
     // Blok kodingannya
}
*/

  • Yang terpenting, jangan banyak ngomen!

Lho, ini apa? Kok sangat bertentangan dengan tips-tips sebelumnya?

Ingat, ukuran file akan lebih besar dan akan lebih lama dibaca karena didominasi dengan komentar. Inilah mengapa banyak file-file HTML yang sedikit lebih lama ditampilkan oleh browser karena terlalu banyak komentar di dalamnya.

Lho, jadi saya harus bagaimana? Komentarkan perlu juga untuk segala sesuatu yang telah dijabarkan sebelumnya? Atau bahkan pada HTML, komentar dapat menjelaskan bahwa akhiran sebuah elemen, </div> misalnya, milik siapa induknya.

Maksud saya, selama tidak perlu memakai komentar, ya tidak usah. Misal, jangan lakukan hal seperti ini:

var abc : int = 90; // ini adalah variabel untuk menentukan radius lingkaran besar

Namun lakukanlah,

var radiusLingkaranBesar : int = 90;

Lebih bersih bukan? Jadi kita pun tidak perlu lelah-lelah untuk membaca kanan kiri. Jangan khawatir menulis variabel seperti itu melelahkan, karena sekarang banyak software text editor yang dibekali dengan autocomplete sehingga kalian cukup pilih sugesti-sugestinya dan tekan enter.


Yup, hanya sebatas itu saja tips dari saya pribadi mengenai manajemen komentar. Siap dengan proyek besar? Semoga tips ini bermanfaat untuk membuat proyek besar yang perlu beberapa tim.

Baik, silakan dilanjutkan ngomennya ~

  • Selesai membaca? Jangan pergi dulu! 😉

    Minta waktunya sebentar dong, plis sebentaaarrr doang. Gak sampe 5 menit saya janji. Anandastoon minta saran dan komplain kalian di formulir berikut untuk membuat situs ini menjadi lebih baik. Komplain kalian sangat berarti bagi Anandastoon. Makasih ya sebelumnya.
    Oiyak! Untuk melihat apakah saran kalian didengar Anandastoon atau tidak, bisa cek ke halaman penerapan komplain berikut...


    Diskusi dengan Anandastoon


    Anandastoon baru saja buat forum untuk diskusi dengan sesama pembaca. Temanya banyak, mulai dari pengalaman horor, menarik, travelling, curhat, tanya jawab, programming, dan lain sebagainya. Mari kunjungi Forum Anandastoon

  • 0 Jejak Manis yang Ditinggalkan

    Leave a Reply

    Your email address will not be published. Required fields are marked *

    Kembali
    Ke Atas
    Mode Gelap