Terkadang, meski tidak sering, saya harus memasukkan logika matematika ke dalam kode saya. Konsep yang digunakan sebagian besar sangat sederhana, tetapi kode yang dihasilkan tidak - banyak variabel dengan tujuan yang tidak jelas, dan beberapa operasi dengan maksud yang tidak begitu jelas. Saya tidak berarti bahwa kode tidak dapat dibaca atau unmaintainable, hanya saja waaaay lebih sulit untuk memahami daripada soal matematika yang sebenarnya. Saya mencoba mengomentari bagian-bagian yang paling sulit untuk dipahami, tetapi ada masalah yang sama seperti hanya dalam mengkodekannya - teks tidak memiliki kekuatan ekspresif matematika .
Saya mencari cara yang lebih efisien dan mudah dipahami untuk menjelaskan logika di balik beberapa kode kompleks, lebih disukai dalam kode itu sendiri. Saya telah mempertimbangkan TeX - menulis dokumentasi dan membuatnya secara terpisah dari kode. Tapi kemudian saya harus belajar TeX, dan dokumentasinya tidak akan ada dalam kode itu sendiri. Hal lain yang saya pikirkan adalah mengambil gambar dari notasi matematika, persamaan dan diagram yang ditulis pada kertas / papan tulis, dan memasukkannya ke dalam javadoc.
Apakah ada cara yang lebih sederhana dan lebih jelas?
PS Memberikan nama deskriptif ( timeOfFirstEventbukan t1) ke variabel sebenarnya membuat kode lebih verbose dan bahkan lebih sulit dibaca.
