integra-document-code

To write JSDoc comments that explain rationale, document the "why, not what" principle by focusing on maintainability and future-readiness. Apply consistent function headers and inline notes that capture the reasoning behind logic, aligning with defined commenting standards for JavaScript and TypeScript code.

Structuring inline vs block comments for maintainability involves using block comments for function headers and JSDoc guidance, while reserving inline notes for specific rationale. This separation improves readability and ensures future-readability by clearly distinguishing broad usage from localized logic explanations.

Applying information-hiding practices when documenting JavaScript and TypeScript code involves referencing guidelines to expose only necessary usage details in JSDoc. It hides internal implementation complexities, ensuring consistent documentation that improves overall readability and maintainability across the project.

Yes, you can use this approach to generate consistent TODO conventions across a JavaScript codebase. It identifies missing rationale and produces standardized inline notes and TODO markers according to defined commenting standards, ensuring future-readiness and maintainability.

You need to document code rationale instead of just describing the implementation when the logic's purpose is not obvious. Applying the "why, not what" principle ensures future maintainability by capturing the reasoning behind decisions, rather than restating what the code already clearly shows.