pengantar

Komentar sebenarnya sangat berguna dalam pemrograman jika ditempatkan dengan baik. Tetapi sebagian besar waktu komentar tidak begitu "baik".

Komentar buruk dapat menyebabkan informasi yang salah, membuang-buang waktu, menciptakan kebiasaan buruk, dll.

Pada artikel ini, saya akan memandu Anda bagaimana menghindari menulis komentar buruk

Komentar Buruk

Komentar kedaluwarsa

Komentar yang sudah usang, usang, tidak relevan, atau memberikan informasi yang salah. Komentar bisa menjadi tua dengan sangat cepat, karena basis kode bisa berubah setiap hari, teknologi bisa berubah setiap hari.

Bagaimana menyelesaikan:

• Perbarui sesegera mungkin
• Hapus saja sebenarnya

Tata bahasa yang salah, terlalu banyak penanda, gumaman, plopping hanya ditulis dengan buruk. Menurut kode bersih, komentar yang layak ditulis layak ditulis dengan baik. Jika Anda akan menulisnya, luangkan waktu Anda untuk memolesnya dan pilih kata-kata Anda dengan hati-hati.

Kode yang dikomentari

Ini adalah jenis komentar terburuk, membuat saya gila setiap kali saya melihat potongan kode yang dikomentari. Kode itu tidak melakukan apa-apa, mereka duduk di sana dan membusuk. Tapi tidak ada yang tahu kapan harus menghapusnya karena “mungkin seseorang akan membutuhkannya”

Bagaimana mengatasinya? Hapus saja ! Saat ini Git menjadi sangat berharga, kita dapat menemukannya jika seseorang benar-benar membutuhkannya

Komentar berlebihan

Ini juga mengerikan, lihat ini:

for(let i = 0; i < 10; i++){
  a = b // assign a to b
}

// a function returns sum of a and b
function sum(a, b){ return a + b}

Hapus saja .

Komentar berisik

Beberapa komentar hanya berisik. Pernahkah Anda melihat komentar seperti ini?

// the name
private String name
// the version
private String version
// the constructor
constructor()

//The 123213 License
//
//Copyright (c)123213213213213, and Contributors
//
//Permission to use, copy, modify, and/or distribute this software for any
//purpose with or without fee is hereby granted, provided that the above
//copyright notice and this permission notice appear in all copies.
//
//THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
//WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
//MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
//ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
//WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
//ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
//IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Komentar HTML

Tidak banyak yang bisa dikatakan tentang ini, menurut saya komentar HTML tidak berguna sama sekali. Kami memiliki ID, nama kelas, nama tag, dan ribuan cara lain untuk mengetahui arti dari sebuah kode. Mengapa repot-repot menulis komentar untuk mereka?

Kesimpulan

Meskipun beberapa komentar sebenarnya diperlukan dan bermanfaat, namun sebagian besar komentar tidak. Saya tahu artikel ini mungkin tidak begitu positif, tetapi saya hanya ingin membenarkan bahwa:

Jika kode Anda buruk, jangan berkomentar untuk itu, bersihkan saja

Pada artikel selanjutnya saya akan menulis tentang cara menulis komentar yang baik, silakan tekan tombol ikuti untuk memeriksanya di masa mendatang.

Terima kasih sudah membaca

Kata-kata terakhir

Meskipun konten saya gratis untuk semua orang, tetapi jika menurut Anda artikel ini bermanfaat, Anda dapat membelikan saya kopi di sini