Descriptive comments

When you write code, you need to comment it so that when you or somebody else comes back to this code few years/months/days/hours from now, they will be able to figure out what the code does. Here is the comment I saw one of my interns write:

// This function divides Numerator by Denominator

Really? I thought numerators and denominators are usually multiplied!

Leave a Reply

Your email address will not be published. Required fields are marked *