Global Commenting

Write code comments by prioritizing self-documenting code first—use clear naming and logical structure—then add strategic comments only for complex algorithms, non-obvious business logic, and public API JSDoc. Avoid redundant comments that restate what the code obviously does.

Use JSDoc for all exported functions and classes to document their public API. JSDoc provides structured, maintainable API documentation and integrates with IDEs for inline help, making your code more accessible to other developers.

Self-documenting code uses expressive naming, clear structure, and logical flow to make intent obvious without comments. Comments complement this by explaining why decisions were made or clarifying non-obvious steps, not by restating what code already shows.

Write evergreen comments that explain underlying logic or non-obvious decisions rather than temporary notes or change tracking. Review comments during code review to remove those restating obvious code, ensuring they add real value and remain valid as code evolves.

Yes, you can include Korean API descriptions in JSDoc comments for Swagger documentation and team clarity. Use Korean descriptions in your JSDoc blocks for exported APIs to serve both English-reading code and localized documentation systems.

Document complex algorithms with concise comments that explain the underlying logic, key steps, or non-obvious reasoning—not a line-by-line restatement. Place comments before the algorithm or at decision points to clarify intent and help maintainers understand the approach.