July 1, 2021

What is the best way to document while trying to understand some code?

What is the best way to document while trying to understand some code?

I am working on some software which has tonnes of code files. I tend to easily forget the requirement of functions, the purpose of variables used etc. This code also has some theory (science and maths) behind it, so it would be best if I could include this too while creating my own learning notes or documentation for it.

What's the best possible way to do it?

Thanks in advance!

submitted by /u/next_mile
[link] [comments]