Mengapa semua orang menulis komentar yang harus dilakukan dalam huruf kapital? [Tutup]
9
Saya melakukan hal yang sama. Ketika ada sesuatu "yang harus dilakukan" dalam kode saya, saya menulis //TODO .... Tapi saya ingin tahu kapan ini dimulai dan apakah ada alasan untuk menulis "to-dos" dalam huruf kapital semua?
Karena kita benar-benar MENGATAKANNYA (kita tidak pernah benar-benar berhasil melakukannya)
Anthony Pegram
3
jadi editor dapat menandai mereka dan membiarkan Anda mencari melalui mereka (daftar tugas eclipse misalnya)
ratchet freak
6
Karena Anda tidak dapat benar-benar membuat teks tebal di dalam kode, Anda perlu beberapa cara untuk membuat hal-hal penting menonjol. Karenanya ...
Karlson
4
Mengapa itu penting?
Benteng
3
Saya menulis//todo:...
BЈовић
Jawaban:
23
Juga, sangat menyenangkan memiliki cara untuk dengan mudah mencari bagian kode yang Anda pilih dan ingin kembali. Anda dapat melakukan pencarian case-sensitive untuk "TODO" untuk segera menemukan apa yang Anda lewati sebelumnya.
"todo" (huruf kecil) berpotensi menjadi bagian dari kata / fungsi / variabel yang lebih besar, tetapi "TODO" (huruf besar) mungkin tidak akan menjadi.
Ini juga memungkinkan editor untuk menyoroti ini. gedit melakukannya, misalnya, dan hanya melakukannya untuk semua huruf besar TODO. Apa pun alasannya, cukup insentif bagi saya untuk menuliskannya dalam huruf besar.
4
@ Darnan: Itu tautologi. Itu dilakukan untuk menonjol, sehingga orang menggunakannya, jadi seseorang menambahkan sintaks yang disorot dalam vim agar lebih menonjol, jadi orang menggunakannya untuk menonjol. Orang tidak menggunakannya karena editor membuatnya menonjol, mereka menggunakannya karena itu biasa dilakukan dan dengan demikian editor membuatnya menonjol. Anda dapat membuat apa pun yang menonjol di vim cukup mengubah sintaks yang tepat itu sama mudahnya untuk membuat todomenonjol tetapi ada sedikit gunanya karena konvensi adalah untuk menggunakan TODO.
Martin York
1
@LokiAstari: Seperti yang saya katakan, saya mengeja dalam huruf besar karena lebih banyak editor menyorotnya secara default. Tapi mungkin saya pengecualian: Cukup muda (jadi saya tidak bisa melakukannya sebelum editor mendukungnya) dan (sayangnya) terlalu banyak orang yang malas dan malas untuk menyesuaikan penyorotan sintaksis secara manual.
Juga bagus untuk pria malang yang perlu membersihkan setelah Anda, dan bagi siapa saja yang perlu melihat kode Anda sebelum selesai. Mereka dapat melihat apa yang belum dilakukan karena konvensi ini.
sq33G
2
Saya telah menemukan kasus campuran TODO dalam nama variabel seperti filesToDownload. Tentu saja, pencarian "hanya kata-kata utuh" memperbaiki masalah itu.
dan04
8
Saya ingin tahu kapan ini dimulai dan apakah ada alasan untuk menulis semua modal?
Gagasan dengan komentar seperti TODO dan FIXME adalah untuk membuatnya menonjol. Anda biasanya tidak ingin mengirimkan kode yang memiliki spidol tersebut dalam kode - mereka menandai hal-hal yang harus dilakukan sebelum proyek dapat dianggap selesai. Menggunakan SEMUA CAPS membuat mereka sedikit lebih mudah dikenali, asalkan Anda tidak menggunakan SEMUA CAPS untuk banyak hal lain dalam kode Anda juga.
itu dan mudah ditemukan melalui grep atau sejenisnya
Zachary K
@ ZakaryK: Tepat!
Dinamis
1
Ini menarik perhatian pada kenyataan bahwa ada todo.
Penting bahwa jelas setiap saat bahwa seseorang perlu kembali ke kode. Informasi khusus hanya perlu diketahui oleh orang yang kembali untuk mengatasi masalah apa pun itu.
Editor lain memiliki fitur pencarian dan Anda dapat dengan mudah mencari todo .
Karlson
Kecuali 'todo' dapat muncul dalam sesuatu yang lain seperti nama variabel, atau teks komentar lainnya ...
sevenseacat
1
vi peka terhadap huruf besar-kecil. Karena huruf kecil digunakan dengan hemat dalam sebagian besar bahasa modern (dalam hal-hal seperti konstanta bernama), pencarian memiliki probabilitas keberhasilan yang tinggi.
ncmathsadist
1
Beberapa editor hanya menyoroti item TODO huruf besar, jadi lebih aman untuk selalu menggunakan huruf besar.
Secara visual SEMUA CAPS menonjol, tetapi tidak terlalu terbaca. Saat membaca kode, mereka memindai sebagai blok dengan ukuran tertentu. Tidak masalah apa surat-surat itu. Mereka hanya menonjol dan dapat dilihat dengan sangat cepat. Setelah Anda bekerja dengan tag untuk sementara waktu, otak Anda akan mengenali kata demi kata.
Dari sudut pandang alat (IDE / Editor), pencarian case sensitif akan memiliki tingkat positif palsu yang sangat rendah pada semua versi huruf besar. Dalam beberapa gaya pengkodean ada risiko kecil bahwa konstanta akan dicocokkan. Pencarian seluruh kata dengan huruf besar-kecil membuat positif palsu lebih kecil.
Setelah alat mendapatkannya di layar format dengan jelas mengatakan lihat DI SINI. Setelah Anda fokus pada lokasi, bagian yang dapat dibaca akan menjadi komentar terkait.
//todo:...Jawaban:
Juga, sangat menyenangkan memiliki cara untuk dengan mudah mencari bagian kode yang Anda pilih dan ingin kembali. Anda dapat melakukan pencarian case-sensitive untuk "TODO" untuk segera menemukan apa yang Anda lewati sebelumnya.
"todo" (huruf kecil) berpotensi menjadi bagian dari kata / fungsi / variabel yang lebih besar, tetapi "TODO" (huruf besar) mungkin tidak akan menjadi.
sumber
TODO. Apa pun alasannya, cukup insentif bagi saya untuk menuliskannya dalam huruf besar.todomenonjol tetapi ada sedikit gunanya karena konvensi adalah untuk menggunakan TODO.filesToDownload. Tentu saja, pencarian "hanya kata-kata utuh" memperbaiki masalah itu.Gagasan dengan komentar seperti TODO dan FIXME adalah untuk membuatnya menonjol. Anda biasanya tidak ingin mengirimkan kode yang memiliki spidol tersebut dalam kode - mereka menandai hal-hal yang harus dilakukan sebelum proyek dapat dianggap selesai. Menggunakan SEMUA CAPS membuat mereka sedikit lebih mudah dikenali, asalkan Anda tidak menggunakan SEMUA CAPS untuk banyak hal lain dalam kode Anda juga.
sumber
Eclipse dan Visual Studio memiliki fitur Daftar Tugas yang secara otomatis memberi Anda daftar baris komentar yang memiliki TODO di dalamnya.
sumber
Saya hanya menonjol dan mudah ditangkap ... tidak ada yang rumit!
sumber
Ini menarik perhatian pada kenyataan bahwa ada todo.
Penting bahwa jelas setiap saat bahwa seseorang perlu kembali ke kode. Informasi khusus hanya perlu diketahui oleh orang yang kembali untuk mengatasi masalah apa pun itu.
sumber
Jika Anda adalah pengguna vi digunakan:
Anda akan sampai di sana dengan sangat cepat.
sumber
Beberapa editor hanya menyoroti item TODO huruf besar, jadi lebih aman untuk selalu menggunakan huruf besar.
sumber
Secara visual SEMUA CAPS menonjol, tetapi tidak terlalu terbaca. Saat membaca kode, mereka memindai sebagai blok dengan ukuran tertentu. Tidak masalah apa surat-surat itu. Mereka hanya menonjol dan dapat dilihat dengan sangat cepat. Setelah Anda bekerja dengan tag untuk sementara waktu, otak Anda akan mengenali kata demi kata.
Dari sudut pandang alat (IDE / Editor), pencarian case sensitif akan memiliki tingkat positif palsu yang sangat rendah pada semua versi huruf besar. Dalam beberapa gaya pengkodean ada risiko kecil bahwa konstanta akan dicocokkan. Pencarian seluruh kata dengan huruf besar-kecil membuat positif palsu lebih kecil.
Setelah alat mendapatkannya di layar format dengan jelas mengatakan lihat DI SINI. Setelah Anda fokus pada lokasi, bagian yang dapat dibaca akan menjadi komentar terkait.
sumber