Comments Rule

Comment Policy

Unacceptable Comments

• Comments that repeat what code does
• Obvious comments ("increment counter")
• Comments instead of good naming
• Do not delete existing comment not following this policy, only apply to new comment you write

Principle

Code should be self-documenting. If you need a comment to explain WHAT the code does, consider refactoring to make it clearer. Comments should be concise like a developer would write for future self.