How can I write effective code comments?

What are some best practices for writing effective code comments?

Effective code comments should be clear, concise, and relevant. They should explain the 'why' behind the code, not just the 'what'. Use comments to clarify complex logic, document assumptions, and provide context.

Can you give me examples of good and bad comments?

Sure! A good comment might say, 'This function calculates the total price after applying discounts to ensure accurate billing.' A bad comment would be, 'This function does stuff.' The first explains the purpose, while the second is vague.

How do I decide when to comment?

Comment when the code is not self-explanatory, when you implement complex algorithms, or when you make decisions that might not be obvious to others. If you think future developers (or you) might be confused, it's a good time to add a comment.

Should I comment on every line of code?

No, avoid commenting on every line. Instead, focus on explaining the overall logic and any complex sections. Too many comments can clutter the code and make it harder to read.