Apakah ada metode untuk membedakan komentar informatif dari kode yang dikomentari?

Sepanjang program, Anda akan berakhir dengan beberapa komentar yang menjelaskan kode dan beberapa komentar yang menghapus kode:

// A concise description 
const a = Boolean(obj);
//b = false;

Apakah ada metode yang baik untuk mem-parsing yang mana?

Saya telah bermain-main dengan menggunakan 3 /dan /** */untuk komentar deskriptif.

Saya juga menggunakan plugin VSCode untuk menyorot //TODO:dan//FIXME:

Ada solusi yang sangat sederhana untuk ini: hapus kode komentar.

Sungguh, hanya ada dua alasan bagus untuk mengomentari kode: untuk menguji sesuatu / melakukan perbaikan, atau untuk menyimpan kode yang mungkin Anda gunakan nanti. Jika Anda menguji atau memperbaiki sesuatu, hapus kode yang berkomentar segera setelah Anda selesai dengan tes atau perbaiki. Jika Anda menyimpan kode yang mungkin Anda gunakan nanti, buatlah kode kelas satu dan letakkan di suatu tempat seperti perpustakaan di mana dapat dimanfaatkan dengan baik.

Menambahkan ke jawaban yang sangat bagus dari @ RobertHarvey, saya percaya hanya ada satu alasan sah yang pernah saya temui untuk menyimpan kode komentar ke kontrol sumber, bahkan untuk sementara: dalam kasus kode pengganti yang tidak jelas yang tidak boleh atau tidak dapat digunakan sekarang karena alasan tertentu . Meski begitu sebagian besar komentar harus penjelasan, bukan kode penggantian. Ini bisa berupa bug atau fitur bahasa yang belum dianggap stabil. Mungkin terlihat seperti ini:

# TODO: Replace with `foo = frobnicate(bar)` once <link.to/bug> is fixed
foo = [some complex workaround]

Dalam hal ini, pekerjaan sudah dilakukan, tetapi Anda belum bisa memanfaatkannya, jadi menghapusnya berarti seseorang harus menemukan kembali nanti. Hal yang sama berlaku untuk solusi suboptimal yang mungkin tampak lebih unggul di hadapannya atau pertukaran timbal balik dengan solusi serupa .

Perhatian: Jangan membuang kode Anda dengan solusi alternatif. Setiap tugas dapat dilakukan dengan berbagai cara tanpa batas, dan tidak hemat biaya untuk menjelajahi ruang ini untuk waktu yang lama untuk setiap perubahan. Ulasan kode dapat menjadi tempat yang baik untuk menemukan komentar yang hilang tersebut, ketika kolega Anda menyarankan perbaikan yang Anda temukan tidak optimal.

Hmm, saya membaca pertanyaan ini sedikit berbeda dari Robert yang dengan benar menyatakan bahwa kode yang dikomentari harus dihapus.

Namun, jika Anda mencari konvensi untuk menandai kode untuk dihapus nanti, favorit lama saya adalah:

//b = false; //TODO: remove

Beberapa flag IDE //TODO:berkomentar atau dapat diajarkan. Jika tidak, biasanya itu adalah string yang dapat dicari. Yang terbaik adalah mengikuti konvensi apa pun yang telah dibuat oleh toko Anda karena ini dapat dilakukan dengan beberapa cara. Setiap basis kode harus melakukan ini dengan satu cara. Tetap dicari.

cepat parse yang mana?

Tanpa tanda itu cara otomatis untuk melakukan ini adalah dengan kompiler. Jika menghapus komentar menghasilkan kode yang mengkompilasi, itu pasti kode yang berkomentar. Menulis plugin IDE yang memeriksa itu tidak akan sulit. Tapi itu akan meninggalkan kode komentar kereta di belakang.

Inilah sebabnya mengapa lebih baik hanya menandai kode yang dikomentari sebagai kode saat Anda berkomentar. Ini memungkinkan Anda bekerja tanpa merusak saat Anda memutuskan apakah Anda benar-benar ingin itu hilang. Karena kita semua terganggu, dan agak pelupa, jangan heran jika beberapa baris diperiksa saat dalam keadaan itu. Jika mereka melakukannya itu bagus bahwa mereka setidaknya ditandai dengan jelas dan dapat dicari. Makro keyboard telah membantu saya dengan ini di masa lalu. Sulit untuk terganggu di tengah-tengah ini jika Anda dapat melakukannya dengan satu ketukan.

Anda dapat mengambil ini sejauh mengabadikan tanda dalam tes integrasi berkelanjutan Anda. Ups, saya mencoba memeriksa dengan TODO yang luar biasa lagi.

Saya menggunakan arahan preprosesor untuk menghapus kode, bukan komentar sama sekali:

//comment
active_code();
#if FALSE
inactive_code();
#endif

Ini membuat hal yang sangat mudah untuk dicari, dan stabilo sintaksis saya memperlakukannya sebagai komentar. Saya bahkan dapat menciutkannya menjadi satu baris:#if FALSE(...)

Anda dapat memperluas gagasan itu untuk memiliki beberapa opsi:

#if OPTION == 0
code_for_option_0();
#elif OPTION == 1
code_for_option_1();
#else
code_for_all_other_options();
#endif

Dan kompilasi pengecekan kesalahan waktu:

#if FOO >= 5
#error FOO should be less than 5!
#endif

Tentu saja, Anda tidak ingin berlebihan dalam hal ini, atau menjadi sulit untuk mengatakan apa yang sebenarnya dikompilasi dan apa yang tidak. Tetapi Anda mendapatkan idenya, dan itu adalah masalah yang sama seperti untuk kode yang dikomentari ... selama Anda hanya menggunakannya secara statis. Jika kondisi Anda dinamis, itu lebih buruk.

Untuk menentukan yang mana dalam basis kode yang ada yang tidak mempertimbangkan masalah ini sama sekali, saya tidak berpikir ada solusi universal. Anda harus menemukan pola sendiri dan mungkin kode regex untuk menemukannya.

Saya setuju dengan jawaban yang menyatakan bahwa kode lama harus dihapus daripada dikomentari jika memungkinkan, namun saya telah mengamati konvensi untuk beberapa kesempatan ketika kode berkomentar diperlukan.

(Basis saya adalah C # tetapi ini dapat diterapkan ke bahasa sintaksis C misalnya java)

// An explanatory comment has a space between the comment marker and the content.

// The following lines are commented out code so do not have the space (except where indented).
//var a = something();
//if(a==2) {
//   doSomethingElse();
//}

Saya masih menafsirkan pertanyaan yang berbeda, berpikir Anda ingin menemukan kode komentar.

Kode C-style pasti memiliki semi-titik dua di dalamnya sementara komentar tidak mungkin memiliki semi-titik dua di dalamnya. Jadi untuk satu baris kode komentar Anda dapat menggunakan ekspresi reguler ini:

\s*\/\/[\s\S]*;

Untuk kode komentar multi-baris bisa jadi

\/\*[^\;]*;[^\;]*\*\/

Catatan Visual Studio agak aneh tentang jeda baris dalam ekspresi reguler, mereka tidak dihitung sebagai spasi putih, Anda perlu menentukan \ n eksplisit.

Jika Anda menggunakan editor dengan kompiler berjalan di latar belakang (seperti Xcode dan Dentang), Anda bisa mencoba mengkompilasi teks komentar. Misalnya "deskripsi ringkas" memberikan kesalahan, "b = false;" tidak. Anda kemudian dapat menggunakan berbagai penyorotan sintaksis.

Metode yang lebih sederhana adalah plugin IDE yang menggunakan beberapa heuristik, seperti beberapa kata dalam satu baris selain dari kata kunci yang menunjuk pada komentar, pencocokan titik kurung kurawal untuk kode dll.

Jawaban lain mencakup variasi pada tema "jangan komentar kode". Tetapi kadang-kadang Anda masih menginginkannya untuk referensi.

Jika Anda benar-benar membutuhkan kode untuk tetap bertahan, solusi yang lebih baik adalah mengelilingi kode dengan "#jika 0 ... #endif", idealnya dengan komentar untuk mengatakan alasannya. Ini adalah strategi yang direkomendasikan dari berbagai standar pengkodean, termasuk MISRA.

Sederhana, setidaknya untuk saya - dan di C / C ++. Komentar terlampir di / * * / informatif. Kode uji yang dihapus sementara dikomentari dengan memimpin //.

Dan ada alasan bagus untuk meninggalkan kode tes dalam file tetapi berkomentar, setidaknya dalam jenis pekerjaan yang saya lakukan. Cepat atau lambat seseorang akan menginginkan perubahan yang dibuat, yang membutuhkan kode itu. Membatalkan komentar blok membutuhkan satu perintah editor, seperti halnya mengomentari ulang di mana Anda selesai.