What are some examples of good code comments?

What are some examples of good code comments?

Good code comments explain the 'why' behind complex logic. For example, instead of just stating what a function does, you might say: 'This function calculates the total price after applying discounts to encourage better pricing strategies.'

Can you give me more examples?

Sure! Here’s another example: 'This loop iterates through the user list to find active users, as inactive users should not receive notifications.'

What should I avoid in code comments?

Avoid comments that state the obvious, like 'increment i by 1' next to 'i++'. Instead, focus on explaining the purpose or reasoning.

How do I know if my comments are effective?

You can ask yourself if someone unfamiliar with your code would understand the intent and logic behind it. If not, revise your comments.