Rehat kopi #79. 10 kesalahan yang dilakukan pengembang Java yang menghalangi mereka mencapai kesuksesan. Panduan Pengembang untuk Menulis Komentar Kode yang Bermakna

10 Kesalahan yang Dilakukan Pengembang Java yang Mencegah Kesuksesan Mereka

Sumber: Dev.to Berdasarkan pengalaman saya, saya telah menyusun daftar 10 kesalahan yang dilakukan pengembang yang menghalangi mereka mencapai kesuksesan:

1. Jangan menulis unit test

Pengembang yang tidak menulis pengujian unit membuat lebih banyak kesalahan dalam kodenya. Hal ini menyebabkan ketidakstabilan produk dan ketidakpuasan pelanggan.

2. Mereka tidak memeriksa kode secara manual

Meskipun Anda sepenuhnya menutupi kode Anda dengan pengujian unit, masih ada kemungkinan Anda melewatkan sesuatu. Selalu disarankan untuk menguji kode Anda secara manual sebelum mengirimkannya untuk ditinjau. Dengan cara ini Anda dapat mendeteksi kesalahan pada tahap pengembangan.

3. Mereka berpikir: “Ini tidak akan pernah terjadi.”

Pengembang sering kali membuat kesalahan saat menulis kode baru, berpikir bahwa skenario tertentu tidak akan pernah terjadi. Pada akhirnya ternyata mereka salah. Tangani semua skenario di mana kode dapat dieksekusi. Metode pemrograman defensif akan membantu Anda dalam hal ini.

4. Jangan mendapat umpan balik

Mintalah umpan balik secara teratur dari pengembang dan pengguna lain. Bagikan pendapat Anda dengan kolega Anda.

5. Mereka tidak memeriksa fungsionalitas kode.

Seringkali pengembang menulis kode mereka sendiri, tetapi tidak memeriksa fungsinya. Akibatnya, ketika kode mencapai produksi, menimbulkan berbagai masalah.

6. Tulis kode prosedur yang panjang

Sangat mudah untuk menulis metode yang panjang dengan banyak logika. Dengan melakukan ini, pemrogram mengimplementasikan logika yang sama di banyak tempat. Proyek dengan sejumlah besar metode kecil memiliki penggunaan kembali kode yang jauh lebih baik dan lebih mudah dipelihara.

7. Mereka tidak tahu alatnya

Alat adalah perpanjangan tangan Anda. Semakin baik Anda mengenal mereka, Anda akan semakin produktif. Anda pasti sudah familiar dengan IDE yang Anda gunakan. Pelajari perintah cepat, selalu ada perintah yang akan membantu Anda menjadi lebih produktif. Di IntelliJ IDEA, ini adalah Sonar Lint, bug Spot, dan Metrik Kode.

8. Abaikan masalah pada kode

Pengembang yang mengerjakan produk paling sukses terus-menerus mengubah kodenya. Jangan takut untuk memfaktorkan ulang kode Anda. Jika kode Anda diuji unitnya, kecil kemungkinan terjadinya regresi. Pengembang sering kali mengabaikan kode yang bermasalah. Sebagai pengembang, Anda bertanggung jawab untuk menjaga aplikasi dalam kondisi baik. Untuk alasan ini, perbaiki masalah apa pun yang Anda temukan.

9. Mereka membuat kode tanpa menyadari konsekuensinya.

Pengembang TIDAK PERNAH melakukan perubahan pada kode dan merilisnya ke dalam produksi tanpa memahami konsekuensinya. Kode mungkin memberikan hasil yang benar untuk nilai pengujian yang diberikan. Namun, ada beberapa skenario di mana hal ini dapat menimbulkan hasil yang tidak terduga dan menimbulkan masalah serius. Pengkodean yang “tidak dapat diprediksi” sering kali terjadi ketika pengembang menggunakan fungsi dari perpustakaan yang tidak sepenuhnya mereka pahami. Hal ini juga bisa terjadi ketika pengembang memperbaiki suatu masalah tanpa memahami solusinya.

10. Jangan meminta bantuan

Pengembang bukanlah orang yang mudah bergaul. Mereka suka menyelesaikan masalahnya sendiri. Namun era ketika seorang pengembang sendiri menciptakan produk dari awal hingga akhir telah berakhir. Pengembangan perangkat lunak adalah aktivitas tim. Ketika Anda menemui masalah saat memprogram, cobalah menyelesaikannya sendiri. Namun jangan buang waktu terlalu banyak jika Anda tidak dapat menemukan solusi. Kemungkinan besar beberapa rekan Anda pernah mengalami masalah yang sama dan mengetahui solusinya. Ini akan menghemat waktu dan meningkatkan produktivitas.

Panduan Pengembang untuk Menulis Komentar Kode yang Bermakna

Sumber: Stepsize Dalam kebanyakan kasus, Anda bukan satu-satunya yang mengerjakan proyek atau basis kode yang sama. Artinya orang lain harus memahami kode Anda. Hal ini juga berlaku untuk komentar kode. Pengembang sering kali menulis komentar “cepat dan kotor” tanpa banyak konteks, sehingga membuat rekan mereka bingung tentang apa yang ingin disampaikan oleh penulisnya. Ini adalah praktik yang buruk dan menciptakan lebih banyak kebingungan daripada kejelasan. Memiliki komentar kode yang jelas membantu pengembang lain. Komentar kode yang menjelaskan suatu fungsi, dasar pemikirannya, masukan, dan keluarannya mempercepat proses pembelajaran bagi pengembang lain. Di sisi lain, komentar kode membawa kita pada pertanyaan: apakah layak untuk menuliskannya? Sekelompok besar pengembang menentang penulisan komentar kode. Pasalnya, kode tersebut menurut mereka sudah cukup jelas. Jika pengembang lain tidak dapat memahami tujuan kode Anda dengan melihatnya, maka itu adalah kode yang buruk. Mungkin ini benar. Namun pikirkan tentang upaya kecil yang diperlukan untuk mengomentari kode dan potensi manfaat yang dihasilkannya. Komentar kode penting untuk mempercepat proses orientasi bagi pengembang mana pun, terutama junior. Mari kita lihat berbagai jenis komentar kode.

1. Komentar pada dokumentasi.

Tujuan utama dari komentar tersebut adalah untuk memperjelas tujuan file atau komponen dengan cepat. Daripada membaca seluruh kode komponen untuk memahami fungsinya, Anda dapat menambahkan komentar kode di bagian atas file `indeks`. Ini akan membantu menjelaskan fungsi komponen ini. Saya bukan penggemar jenis komentar seperti ini karena kodenya sedikit berantakan. Saya pikir jenis komentar arsitektur ini harus ada dalam dokumentasi internal Anda di mana Anda dapat memelihara dan mendiskusikan arsitektur proyek Anda secara terpusat. Namun, proyek open source sangat membutuhkannya.

2. Komentar tentang fungsi.

Ini adalah jenis komentar yang paling berguna. Mereka menjelaskan tujuan fungsi, parameternya, dan keluarannya.

/**
 * @desc Creates a welcome message
 */
function sayHello(name) {
    return `Hello ${name}`;
}

3. Komentar yang logis.

Ini adalah komentar dalam fungsi untuk memperjelas jalur kode yang kompleks. Seperti yang sudah Anda duga, kehadiran komentar seperti itu menunjukkan bahwa kode Anda terlalu rumit. Selain itu, komentar logis sering kali berisi terlalu banyak informasi detail. Tingkat detail akan menciptakan lebih banyak kekacauan dan mengurangi keterbacaan kode Anda. Berikut adalah contoh komentar kode yang terlalu detail.

let date = new Date(); // store today's date to calculate the elapsed time

Komentar Kode: 4 Praktik Terbaik untuk Mengomentari

1. Gunakan anotasi atau tag kode

Banyak bahasa pemrograman yang menentukan standar untuk mengomentari kode. Java menggunakan Javadoc , sedangkan JavaScript menggunakan sistem komentar kode JSDoc , yang didukung oleh banyak alat dokumentasi. Untuk fungsi Anda harus menyertakan tag kode berikut:

• @desc - deskripsi fungsi Anda
• @param - semua parameter masukan yang diterima fungsi. Pastikan untuk menentukan jenis masukan.
• @returns - mengembalikan keluaran. Pastikan untuk menentukan jenis keluaran.
• @throws adalah jenis kesalahan yang dapat ditimbulkan oleh fungsi tersebut.
• @example - satu atau lebih contoh yang menunjukkan masukan dan keluaran yang diharapkan.

Berikut adalah contoh kode Lodash untuk fungsi chunk .

/**
 * Creates an array of elements split into groups the length of `size`.
 * If `array` can't be split evenly, the final chunk will be the remaining
 * elements.
 *
 * @since 3.0.0
 * @category Array
 * @param {Array} array The array to process.
 * @param {number} [size=1] The length of each chunk
 * @returns {Array} Returns the new array of chunks.
 * @example
 *
 * chunk(['a', 'b', 'c', 'd'], 2)
 * // => [['a', 'b'], ['c', 'd']]
 *
 * chunk(['a', 'b', 'c', 'd'], 3)
 * // => [['a', 'b', 'c'], ['d']]
 */
function chunk(array, size = 1) {
  // logic
}

2. Jelaskan alasan tindakan Anda

Banyak pengembang menggunakan komentar untuk menjelaskan fungsi kode mereka. Saat melakukannya, pastikan untuk menyertakan alasan Anda membuat fitur atau komponen tertentu. Informasi ini disebut konteks. Konteks penting untuk memberikan lebih banyak informasi kepada pengembang tentang keputusan desain di balik fitur atau komponen. Konteks sangat penting ketika pengembang lain ingin melakukan perubahan pada fitur atau komponen Anda. Di bawah ini Anda dapat melihat contoh kode komentar yang buruk tanpa konteks.

/**
 * Sets the label property of a new form.
 *
 * @param label text for label of form
 */
function setFormLabel(label) {
    // logic
}

3. Jangan menautkan ke dokumen atau komentar lain

Tidak disarankan untuk menautkan ke komentar kode lain atau dokumen internal yang menjelaskan suatu fitur atau komponen.

/**
 * Sets the label property of a new form.
 *
 * @see {@link https://myinternaldocument.com}
 */
function setFormLabel(label) {
    // logic
}

4. Tulis komentar sambil coding

Ini mungkin tampak jelas, namun banyak pengembang (termasuk saya sendiri) mengabaikan aturan ini. Meninggalkan komentar untuk nanti adalah hal yang buruk karena Anda mungkin lupa beberapa logika yang Anda tulis, yang akan menyebabkan kualitas komentar yang lebih rendah. Hal ini terutama berlaku jika Anda telah mengerjakan permintaan penarikan yang sama selama beberapa hari. Lebih baik menulis komentar ketika Anda baru saja menyelesaikan suatu fitur atau modul. Ingatlah untuk membuat komentar kode sesingkat mungkin. Anda tidak perlu menghabiskan lebih banyak waktu untuk menulis komentar daripada menulis kode itu sendiri.