Code Comment

Definitions

1. Non-executable text embedded in source code to explain intent, assumptions, constraints, or tricky behavior to future readers. Good code comments clarify why something unusual exists rather than restating obvious mechanics already visible in the code itself.

   In plain English: Written notes inside code that help explain it to readers.

   Example: "The reviewer asked for a code comment explaining why the retry loop intentionally ignored one specific error code from the legacy gateway."

Related Terms

• Markdown
• No Hidden Control Flow
• API Documentation
• Architecture Diagram
• Architecture Document
• Code Documentation
• Code Sample
• Code Tour
• Comment Block