Ngopi #79. 10 kesalahane pangembang Java sing nyegah sukses. Pandhuan Pangembang kanggo Nulis Komentar Kode Bermakna

10 Kesalahan Pangembang Jawa Sing Ngalangi Suksese

Sumber: Dev.to Adhedhasar pengalaman, aku wis nyusun dhaptar 10 kesalahan sing ditindakake para pangembang sing nyegah supaya bisa sukses:

1. Aja nulis tes unit

Pangembang sing ora nulis tes unit nggawe luwih akeh kesalahan ing kode. Iki nyebabake ketidakstabilan produk lan rasa ora puas pelanggan.

2. Padha ora mriksa kode kanthi manual

Sanajan sampeyan nutupi kode kanthi tes unit, isih ana kemungkinan sampeyan ora kejawab. Disaranake kanggo nyoba kode kanthi manual sadurunge ngirim kanggo ditinjau. Kanthi cara iki sampeyan bisa ndeteksi kesalahan ing tahap pangembangan.

3. Padha mikir: "Iki ora bakal kelakon."

Pangembang kerep nggawe kesalahan nalika nulis kode anyar, mikir yen skenario tartamtu ora bakal kelakon. Ing pungkasan dadi metu sing padha salah. Nangani kabeh skenario ing ngendi kode bisa dieksekusi. Cara pamrograman pertahanan bakal mbantu sampeyan.

4. Aja njaluk umpan balik

Ajeg njaluk umpan balik saka pangembang lan pangguna liyane. Nuduhake pendapat sampeyan karo kolega sampeyan.

5. Padha ora mriksa fungsi kode.

Asring pangembang nulis kode, nanging ora mriksa fungsine. Akibaté, nalika kode tekan produksi, nggawe macem-macem masalah.

6. Tulis kode prosedural sing dawa

Gampang banget nulis cara sing dawa kanthi logika sing akeh. Kanthi nindakake iki, programer ngetrapake logika sing padha ing pirang-pirang panggonan. Proyèk kanthi jumlah cara cilik sing signifikan duwe panggunaan kode sing luwih apik lan luwih gampang dijaga.

7. Padha ora ngerti piranti

Piranti minangka extension saka tangan sampeyan. Sing luwih apik sampeyan ngerti wong-wong mau, sampeyan bakal luwih produktif. Sampeyan kudu ngerti banget karo IDE sing sampeyan gunakake. Sinau prentah cepet, mesthi ana prentah sing bakal mbantu sampeyan dadi luwih produktif. Ing IntelliJ IDEA iki Sonar Lint, Spot bugs lan Code Metrics.

8. Nglirwakake masalah ing kode

Pangembang sing nggarap produk sing paling sukses terus ngganti kode kasebut. Aja wedi refactor kode sampeyan. Yen kode sampeyan diuji unit, kemungkinan regresi sithik. Pangembang asring nglirwakake kode masalah. Minangka pangembang, sampeyan tanggung jawab kanggo njaga aplikasi ing kondisi apik. Mulane, ndandani masalah sing sampeyan temokake.

9. Padha kode tanpa sadhar jalaran.

Pangembang kudu ora tau nggawe owahan kanggo kode lan ngeculake menyang produksi tanpa mangerteni akibate. Kode kasebut bisa ngasilake asil sing bener kanggo nilai tes sing diwenehake. Nanging, bisa uga ana skenario sing bisa nyebabake asil sing ora bisa ditebak lan nggawe masalah serius. Pengkodean "ora bisa diprediksi" asring kedadeyan nalika pangembang nggunakake fungsi saka perpustakaan sing ora dingerteni. Iki uga bisa kedadeyan nalika pangembang ndandani masalah tanpa mangerteni solusi kasebut.

10. Aja njaluk tulung

Pangembang ora banget sosialisasi. Dheweke seneng ngrampungake masalah dhewe. Nanging jaman nalika siji pangembang dhewe nggawe produk saka wiwitan nganti rampung wis rampung. Pangembangan piranti lunak minangka kegiatan tim. Yen sampeyan nemoni masalah nalika program, coba ngatasi dhewe. Nanging aja mbuwang wektu akeh yen sampeyan ora bisa nemokake solusi. Ana kemungkinan gedhe yen sawetara kolega sampeyan wis nemoni masalah sing padha lan ngerti solusi kasebut. Iki bakal ngirit wektu lan nambah produktivitas.

Pandhuan Pangembang kanggo Nulis Komentar Kode Bermakna

Source: Stepsize Ing sawetara kasus, sampeyan ora mung siji sing nggarap proyek utawa basis kode sing padha. Iki tegese wong liya kudu ngerti kode sampeyan. Iki uga bener kanggo komentar kode. Pangembang asring nulis komentar "cepet lan reged" tanpa akeh konteks, nggawe kanca-kancane bingung babagan apa sing dikandhakake penulis. Iki minangka praktik ala lan nggawe luwih bingung tinimbang kajelasan. Duwe komentar kode sing jelas mbantu pangembang liyane. Komentar kode sing njlèntrèhaké fungsi, alasan, input, lan output nyepetake proses sinau kanggo pangembang liyane. Ing sisih liya, komentar kode ndadékaké kita menyang pitakonan: apa kudu ditulis? Klompok pangembang sing signifikan nentang nulis komentar kode. Alesane yaiku kode kasebut, miturut pendapate, cukup jelas. Yen pangembang liyane ora bisa ngerti tujuan kode sampeyan kanthi ndeleng, mula kode kasebut ora apik. Mbok menawa iki bener. Nanging mikir babagan gaweyan cilik sing dibutuhake kanggo menehi komentar kode lan keuntungan potensial sing digawa. Komentar kode penting kanggo nyepetake proses onboarding kanggo pangembang apa wae, utamane junior. Ayo ndeleng macem-macem jinis komentar kode.

1. Komentar ing dokumentasi.

Tujuan utama komentar kasebut yaiku kanggo njlentrehake kanthi cepet tujuan file utawa komponen. Tinimbang maca kabeh kode komponen kanggo mangerteni apa sing ditindakake, sampeyan bisa nambah komentar kode ing ndhuwur file `indeks`. Iki bakal mbantu nerangake apa komponen iki. Aku ora penggemar amba saka jinis komentar amarga clutters munggah kode dicokot. Aku mikir jinis komentar arsitektur iki kudu ana ing dokumentasi internal sampeyan bisa njaga lan ngrembug babagan arsitektur proyek sampeyan. Nanging, proyek open source pancen mbutuhake.

2. Komentar ing fungsi.

Iki minangka jinis komentar sing paling migunani. Padha njlèntrèhaké tujuan fungsi, paramèter, lan output.

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

3. Komentar logis.

Iki minangka komentar ing fungsi kanggo njlentrehake jalur kode kompleks. Kaya sing wis sampeyan duga, anane komentar kasebut nuduhake yen kode sampeyan rumit banget. Kajaba iku, komentar logis asring ngemot informasi sing rinci banget. Tingkat detail bakal nggawe luwih akeh kekacauan lan nyuda keterbacaan kode sampeyan. Iki minangka conto komentar kode sing rinci banget.

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

Komentar Kode: 4 Praktik Paling Apik kanggo Komentar

1. Gunakake anotasi kode utawa tag

Akeh basa pamrograman nemtokake standar kanggo kode komentar. Jawa nggunakake Javadoc , dene JavaScript nggunakake sistem komentar kode JSDoc , sing didhukung dening akeh alat dokumentasi. Kanggo fungsi sampeyan kudu nyakup tag kode ing ngisor iki:

• @desc - katrangan fungsi sampeyan
• @param - kabeh parameter input sing ditampa fungsi. Priksa manawa sampeyan nemtokake jinis input.
• @bali - bali output. Dadi manawa kanggo nemtokake jinis output.
• @throws jinis kesalahan sing fungsi bisa uncalan.
• @example - siji utawa luwih conto sing nuduhake input lan output samesthine.

Iki minangka conto kode Lodash kanggo fungsi potongan .

/**
 * 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. Terangna sebabe tumindakmu

Akeh pangembang nggunakake komentar kanggo njlèntrèhaké apa kode sing. Nalika nindakake, priksa manawa sampeyan nggawe fitur utawa komponen tartamtu. Informasi iki diarani konteks. Konteks penting kanggo menehi pangembang informasi luwih lengkap babagan keputusan desain ing mburi fitur utawa komponen. Konteks penting nalika pangembang liyane pengin nggawe owah-owahan ing fitur utawa komponen sampeyan. Ing ngisor iki sampeyan bisa ndeleng conto ala komentar kode tanpa konteks.

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

3. Aja nyambung menyang dokumen utawa komentar liyane

Ora dianjurake kanggo nyambung menyang komentar kode liyane utawa dokumen internal sing nerangake fitur utawa komponen.

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

4. Tulis komentar nalika coding

Iki bisa uga katon jelas, nanging akeh pangembang (kalebu aku) nglirwakake aturan iki. Ninggalake komentar mengko ora becik amarga sampeyan bisa uga lali sawetara logika sing sampeyan tulis, sing bakal nyebabake komentar kode kualitas sing luwih murah. Iki luwih bener yen sampeyan wis nggarap panjalukan tarik sing padha sajrone sawetara dina. Iku luwih apik kanggo nulis komentar nalika sampeyan wis rampung fitur utawa modul. Elinga supaya komentar kode minangka ringkes sabisa. Sampeyan ora perlu nglampahi wektu luwih akeh kanggo nulis komentar tinimbang nulis kode kasebut dhewe.