notes

You should avoid adding comments when the code performs simple, self-explanatory operations where restating the logic would only create redundant noise. Comments should only be added when they reveal business intent or clarify complex edge cases.

To write intent-focused code comments, you should document the reasoning behind key decisions, business logic, and edge cases rather than translating simple operations line by line. This approach clarifies the 'why' for future readers without adding redundant noise.

Use JSDoc for exported functions or static methods in TypeScript and JavaScript to provide structured API documentation. Inline comments are better suited for explaining complex logic blocks within your codebase rather than documenting every simple operation.

The best way to comment React hooks and Node.js controllers is to apply concise, intent-focused notes that explain the reasoning behind specific event handlers, state decisions, and service-level edge cases without narrating basic syntax.

To document SQL joins and data pipelines effectively, add concise notes explaining the specific design choices for complex joins and the reasoning behind key data transformations to capture business intent and prevent future logic errors.

You should avoid adding comments when the code performs simple, self-explanatory operations where restating the logic would only create redundant noise. Comments should only be added when they reveal business intent or clarify complex edge cases.