code-annotation

What problem does it solve?

Annotations articulate the rationale, design constraints, and cross-module relationships behind code by describing the non-obvious aspects, without changing behavior.

Core Features & Use Cases

• Reads the full source file before annotating to avoid inferences from names or paths.
• Enforces quality gates to prevent hollow or placeholder comments; includes a calibration protocol for long annotation sessions.
• Produces documentation-friendly annotations for Python and C++ sources, plus templates and guidance for future contributors.

Quick Start

Provide an annotated example of a Python or C++ file that highlights non-obvious logic and reasoning without altering code.