Иногда, хотя и не часто, мне приходится включать математическую логику в мой код. Используемые концепции в основном очень просты, но результирующий код не таков - множество переменных с неясной целью и некоторые операции с не столь очевидным намерением. Я не имею в виду , что код не читается или неосновательный, только что это Waaaay труднее понять , чем актуальная проблема математики. Я пытаюсь прокомментировать те части, которые сложнее понять, но есть та же проблема, что и при простом их кодировании - текст не обладает выразительной силой математики .
Я ищу более эффективный и простой для понимания способ объяснения логики, лежащей в основе сложного кода, предпочтительно в самом коде. Я рассмотрел TeX - написание документации и создание ее отдельно от кода. Но тогда я должен был бы изучить TeX, и документация не будет в самом коде. Еще одна вещь, о которой я подумал, - сфотографировать математические обозначения, уравнения и диаграммы, написанные на бумаге / доске, и включить их в Javadoc.
Есть ли более простой и понятный способ?
PS Задание описательных имен ( timeOfFirstEvent
вместо t1
) переменных фактически делает код более многословным и еще более сложным для чтения.