Apa arti XXX dalam komentar? [Tutup]

Apa yang orang umumnya maksud setiap kali Anda melihat XXXdi komentar. Terkadang, saya akan melihat komentar seperti ini:

# XXX - This widget really should frobulate the whatsit

Tentu saja, saya dapat mengatakan apa arti komentar tersebut, tetapi apa arti XXX secara umum? Apakah itu mengatakan "Ini hack" atau mungkin "Mungkin kita harus mengunjungi ini nanti"? Atau itu mengatakan sesuatu yang lain sama sekali?

Apa yang XXXdiwakili, tergantung pada pembuat kode. Secara umum, ini digunakan sebagai penanda untuk kode yang membutuhkan perhatian.

Namun, halaman web ini menyatakan pemikiran yang agak berbeda:

XXX: digunakan untuk menandai sesuatu yang palsu tetapi berfungsi

FIXME: digunakan untuk menandai sesuatu yang palsu dan rusak

Saya kira ini lebih jauh menunjukkan bahwa artinya tidak didefinisikan dengan baik dan digunakan secara berbeda.

Ini adalah kode yang kotor ;)

Per Wikipedia : "XXX untuk memperingatkan programmer lain tentang kode yang bermasalah atau salah arah." - yang mungkin ditarik dari wadah racun yang bertuliskan "xxx" pada mereka; sekolah super tua.

Jika itu adalah catatan TODO, berikut ini adalah posting blog terkait yang disebut, TODO atau bukan TODO , yang mencakup penggunaan GREP untuk mengurutkan komentar berdasarkan tanggal, pemilik, dll.

Tidak ada artinya. Itu hanya urutan karakter yang secara visual berbeda (yang membuatnya mudah untuk memindai secara visual) dan tidak mungkin muncul dalam kode atau komentar (yang membuatnya mudah untuk mencari secara terprogram).

Jadi, itu digunakan sebagai penanda untuk menandai komentar yang harus mudah dicari. Biasanya, ini menandai sepotong kode yang perlu ditinjau kembali.

IIRC itu adalah anotasi yang ada sebelum dan memiliki arti yang mirip dengan anotasi TODO atau FIXME. Ini cukup umum dalam sumber vim, misalnya.

Kemungkinan besar urutan karakter yang tidak muncul dalam kode reguler, artinya mudah dicari dari baris perintah:

ravn:tmp ravn$ echo XXXX This is very bad > processor.c
ravn:tmp ravn$ echo XXXX Verify defaults before going in production > main.c
ravn:tmp ravn$ grep -R XXXX .
./main.c:XXXX Verify defaults before going in production
./processor.c:XXXX This is very bad
ravn:tmp ravn$ 

(contohnya untuk Unix, saya percaya "findstr" melakukan hal yang sama di bawah Microsoft Windows)

tetapi apa arti XXX secara umum? Apakah itu mengatakan "Ini hack" atau mungkin "Mungkin kita harus mengunjungi ini nanti"? Atau itu mengatakan sesuatu yang lain sama sekali?

Salah satu di atas.

Pilihan XXX versus TODO atau FIXME atau HACK atau yang lainnya tidak diatur oleh aturan atau konvensi yang kuat. Pada dasarnya, itu berarti apa pun yang dimaksudkan oleh orang yang meletakkannya di sana. Ini mungkin jelas ... atau mungkin benar-benar buram bagi Anda.

UPDATE Wikipedia saat ini (2016-03-30) mengatakan:

Tag semacam itu sangat berbeda, tetapi mungkin termasuk:

• ...
• XXX - beri peringatan kepada programmer lain tentang kode yang bermasalah atau salah arah

Perhatikan peringatan yang jelas dalam teks asli. XXX dapat ditafsirkan sebagai singgungan pada "XXX" yang Anda lihat pada racun dan / atau botol nonsen dalam komik klasik, kartun, dll.

Kemungkinan besar itu adalah penanda yang nantinya dapat ditemukan. Tidak seperti TODO atau FIXME atau yang serupa, XXX sangat jarang ditemukan dalam kata atau konstruksi apa pun, oleh karena itu menjadikannya sempurna untuk marker yang akan berdiri sendiri ketika file sedang dicari.

Dari mana saya berasal, kami menggunakan XXX (dan kemudian YYY, ZZZ) untuk angka yang belum kami ketahui, misalnya: tambahkan XXX ke YYY untuk menemukan hasilnya, lalu tambahkan 10%.

Berasal dari persamaan di sekolah di mana 'x' adalah variabel yang tidak diketahui.