Memikirkan semula komen kod

Justin Duke datang dengan idea yang bijak: Bolehkah merawat komen kod sebagai nota kaki membantu kita memahami lebih baik fail kod? Dalam prototaip reka bentuknya, semua komen tersembunyi secara lalai dan perlu diklik untuk dipaparkan.

Idea ini hebat! Reka bentuk Justin mengingatkan saya tentang cara Instapaper mengendalikan nota kaki dalam talian.

Alasan saya suka idea ini mungkin kerana banyak komen tidak perlu dibaca sering - mereka lebih seperti peringatan, "Hei, ini memerlukan peningkatan di masa depan" atau "Oh, itu pelik, saya minta maaf". Mengeluarkan komen -komen ini dari kod juga membuat pengimbasan keseluruhan fail lebih mudah.

Saya ingin tahu jika mungkin untuk menambah butang togol yang menunjukkan semua komen sekiranya anda perlu membaca semua komen mengikut urutan, dan bukannya bertukar satu demi satu.

Singkatnya, semua perbincangan mengenai komen mengingatkan saya tentang ucapan hebat oleh Sarah Drasner di JSConf tahun ini, di mana dia membincangkan mengapa komen begitu sukar untuk ditulis:

Atas ialah kandungan terperinci Memikirkan semula komen kod. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!