Rumman Ansari November 09, 2024 396 views

Not Commenting Code or Over-Commenting

• Mistake: Either providing too few comments, making the code hard to understand, or over-commenting, which can clutter the code.
• Solution: Write clear, concise comments to explain why complex logic exists rather than what the code does. Use comments to provide context where the intent may not be immediately obvious.

---

Failing to Document Code

• Mistake: Skipping documentation or comments, making it harder for others (or even yourself) to understand the code later.
• Solution: Write documentation for public methods, classes, and modules. This is especially useful for complex logic or unusual design decisions.

---