Skip to content

Should statement-level annotation within nested component be parsed (or left as inline commenting)? #32

@chrfrantz

Description

@chrfrantz

In the following expression, the annotation [embeddedAnnotation] in the nested component (a condition in this example), could variably be treated as an annotation to be drawn on component-level (concatenated with [componentAnnotation]).

Cac[componentAnnotation]{ A(actor) I(act) [embeddedAnnotation] Bdir(object) }

If combined, the compound annotation would be [componentAnnotation][embeddedAnnotation]; if ignored (and left as optional comment for the encoder), the compound annotation would merely be [componentAnnotation].

This should be discussed, trading off flexibility in annotation allocation (e.g., to better capture coding intuition) with other use cases, such as internal commentary.

Associated with this, a new convention for inline commentary should be considered, since the use of square brackets is conflicting with syntax elements.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestquestionFurther information is requested

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions