note

Overview

A Note in opC++ is how the compiler links generated code with the original source code.

The process for opCpp code is the following:

1. Read Dialect / Note Configuration
2. Read in Source Code (oh files)
3. Annotate Source Code with Notes
4. Link Generated Code to Notes
5. Final C++ Backend File Result

Note Generation

Note generation is controlled via dialects.

Types of Note Generation Include:

• Special Notes
• Standard Notes
• Maps

Each type of note is generated at a specific location based on specific criteria.

Note Definition

Notes are defined based on the information given along with each note - as well as the note identifier, which provides additional context.

These definitions tie the annotated code together to the dialect and final generated code.