majiayu000 General Development Guidelines
Apply these general guidelines to all code.
Priorities
Focus 80% on readability and 20% on performance.
In order of importance:
- Correctness and functionality
- Readability & Maintainability
- Performance
Comments
Add comments only when they explain WHY, not WHAT. The code itself should be readable enough to show WHAT it does.
DO NOT comment obvious operations
// Bad
// increment counter
counter++;
DO comment
- Business logic reasoning
- Non-obvious decisions
- Workarounds or edge cases
- Complex algorithms (brief summary of approach)
Example of a good comment
// Using ceil() here because partial units must be charged as full units per billing policy
const billableUnits = Math.ceil(usage / unitSize);