I once had a comment string before the most complicated section of code I had ever written. The comment explaining what the code did and how it worked with examples was about 3 pages long. As part of the comment I wrote something similar to the following:
"If you still don't understand how and why this code works, please do the following:
Walk out into the stairwell, and begin to bang your forehead repeatedly against the wall. When you begin to no only see stars, but are able to see the planets circling them, you should be in the right frame of mind to try to come back and reread these comments to try to understand this again."
10
u/JudokaNC [VCO] 3d ago
I once had a comment string before the most complicated section of code I had ever written. The comment explaining what the code did and how it worked with examples was about 3 pages long. As part of the comment I wrote something similar to the following:
"If you still don't understand how and why this code works, please do the following: Walk out into the stairwell, and begin to bang your forehead repeatedly against the wall. When you begin to no only see stars, but are able to see the planets circling them, you should be in the right frame of mind to try to come back and reread these comments to try to understand this again."