code_comment_syntax_errors

Katz 0.174

A comment reference uses `rq:idea` or `rq:idea`.
A path string uses double quotes or single quotes.
A qualified reference may use dotted idea names after the path.
Line comments use `//` and `#`.
The same forms apply in every comment span that the indexer reads.
check reads each comment reference in a non- `.rq` source file.
A comment reference with invalid syntax is a syntax error.
code_comment_syntax_errors reports the syntax error.
The issue kind is `comment_syntax`.
The issue label is the error reason and the comment reference text.
The issue severity is `error`.
A valid comment reference stays a comment_reference site.
An unresolved valid target stays a `comment_link` issue.
A source file that contains only a syntax error stays in the code index.
comment_reference_ignore suppresses the syntax error on the next line.
Related: check references_in_functional_code_comments

implementation

comment.rs, broken.rs, sync.rs, check.ts

status

done

tests

comment.rs:reports_a_malformed_comment_reference, comment.rs:reports_an_unclosed_comment_reference, comment.rs:keeps_a_quoted_bracket_inside_a_qualified_comment_reference, comment.rs:ignores_malformed_rq_inside_strings_and_raw_strings, broken_references.rs:check_reports_a_malformed_comment_reference, broken_references.rs:check_skips_comment_syntax_on_rq_ignore_error

Interactive page: code_comment_syntax_errors