Here's a good example btw of a comment that I found very helpful.
One day a number of years ago, I was reading through some part of the Linux source code (somewhere in the 2.4 series I think), and I was looking at a section of the TCP stack and came across a comment to the effect of "This is the max timeout value as specified in the RFC. This means FTP to Mars will never work"
Perfect comment. Besides making me laugh, it explains why a specific line is the way it is and explains that this may cause some issues where latency in the connection is high enough.
One day a number of years ago, I was reading through some part of the Linux source code (somewhere in the 2.4 series I think), and I was looking at a section of the TCP stack and came across a comment to the effect of "This is the max timeout value as specified in the RFC. This means FTP to Mars will never work"
Perfect comment. Besides making me laugh, it explains why a specific line is the way it is and explains that this may cause some issues where latency in the connection is high enough.