spec - fencing_comments

Katz0.078

Summary

A complete same-line fence keeps `//` and `/*` as prose, not comments.
Closed double quotes: " / / this line " contains no comment.
Closed backticks: `//this line` contains no comment.
Closed backticks with a glob: `@reqlan/*` does not open a block comment.
An unclosed backtick is not a fence, so this line `
An unclosed quote is not a fence, so as does "
The Langium lexer, the Rust lexer, comment scanners, and TextMate must use this rule.
Related: comments, inline_code, naked_strings_in_body, comment_span_align.

Jump to outbound references

Jump to inbound references

Navigation

Source file

reqlan rq/language/syntax-edge-cases.rq

community 1

community cluster

syntax-edge-cases.rq

file cluster

reqlan rq/language

folder cluster

status: done

status cluster

tag: Not present

tag cluster

Printable page

Static print-friendly idea sheet.

Attributes

Key	Value
implementation	reqlan-line-fences.ts, reqlan-token-builder.ts, reqlan-comment-resolver.ts, patch-textmate.mjs, reqlan.tmLanguage.json, lexer.rs, rq_ignore.rs
status	done
tests	parsing.test.ts:parse syntax-edge-cases.rq, comment-in-string.test.ts:isInsideLineFence treats only complete same-line fences as fences, this line in block body is not a line comment, this line in block body is not a line comment, is a line comment, is a line comment, inside complete backtick fences when locating line comments, references.test.ts:findCommentSpansInText treats unclosed fences as comments and closed fences as prose, * inside complete backtick fences, * in block body is not a block comment, * is not a block comment, langium-rust-parse-align.test.ts:fencing_comments, lexer.rs:backticked_slash_star_is_not_a_comment, lexer.rs:quoted_slash_slash_in_body_is_not_a_comment, lexer.rs:backticked_slash_slash_in_body_is_not_a_comment, lexer.rs:unclosed_backtick_then_slash_slash_is_a_comment, lexer.rs:unclosed_quote_then_slash_slash_is_a_comment, rq_ignore.rs:does_not_treat_marker_inside_backticks_as_a_directive

Browse all attributes

Ancestor context

No ancestor chain recorded.

Outbound references

Kind	Idea	Path	Snippet
references	comments	reqlan rq/language/syntax.rq	comments
references	inline_code	reqlan rq/language/syntax.rq	inline_code
references	naked_strings_in_body	reqlan rq/language/syntax.rq	naked_strings_in_body
references	comment_span_align	reqlan rq/core_analysis/rust_port.rq	comment_span_align
file_reference	"../../packages/language/src/reqlan-line-fences.ts"	packages/language/src/reqlan-line-fences.ts	reqlan-line-fences.ts
file_reference	"../../packages/language/src/reqlan-token-builder.ts"	packages/language/src/reqlan-token-builder.ts	reqlan-token-builder.ts
file_reference	"../../packages/language/src/reqlan-comment-resolver.ts"	packages/language/src/reqlan-comment-resolver.ts	reqlan-comment-resolver.ts
file_reference	"../../packages/language/scripts/patch-textmate.mjs"	packages/language/scripts/patch-textmate.mjs	patch-textmate.mjs
file_reference	"../../packages/language/syntaxes/reqlan.tmLanguage.json"	packages/language/syntaxes/reqlan.tmLanguage.json	reqlan.tmLanguage.json
file_reference	"../../crates/reqlan-parse/src/lexer.rs"	crates/reqlan-parse/src/lexer.rs	lexer.rs
file_reference	"../../crates/reqlan-index/src/rq_ignore.rs"	crates/reqlan-index/src/rq_ignore.rs	rq_ignore.rs
file_reference	"../../packages/language/test/parsing.test.ts:parse syntax-edge-cases.rq"	packages/language/test/parsing.test.ts	parsing.test.ts:parse syntax-edge-cases.rq
file_reference	"../../packages/language/test/comment-in-string.test.ts:isInsideLineFence treats only complete same-line fences as fences"	packages/language/test/comment-in-string.test.ts	["../../packages/language/test/comment-in-string.test.ts:isInsideLineFence treats only complete same-line fences as fenc
file_reference	"../../packages/language/test/comment-in-string.test.ts:quoted //this line in block body is not a line comment"	packages/language/test/comment-in-string.test.ts	this line in block body is not a line comment
file_reference	"../../packages/language/test/comment-in-string.test.ts:backticked //this line in block body is not a line comment"	packages/language/test/comment-in-string.test.ts	this line in block body is not a line comment
file_reference	"../../packages/language/test/comment-in-string.test.ts:unclosed backtick then // is a line comment"	packages/language/test/comment-in-string.test.ts	is a line comment
file_reference	"../../packages/language/test/comment-in-string.test.ts:unclosed quote then // is a line comment"	packages/language/test/comment-in-string.test.ts	is a line comment
file_reference	"../../packages/language/test/references.test.ts:ignores // inside complete backtick fences when locating line comments"	packages/language/test/references.test.ts	["../../packages/language/test/references.test.ts:ignores // inside complete backtick fences when locating line comments
file_reference	"../../packages/language/test/references.test.ts:findCommentSpansInText treats unclosed fences as comments and closed fences as prose"	packages/language/test/references.test.ts	["../../packages/language/test/references.test.ts:findCommentSpansInText treats unclosed fences as comments and closed f
file_reference	"../../packages/language/test/references.test.ts:findCommentSpansInText skips /* inside complete backtick fences"	packages/language/test/references.test.ts	* inside complete backtick fences
file_reference	"../../packages/language/test/comment-in-string.test.ts:backticked @reqlan/* in block body is not a block comment"	packages/language/test/comment-in-string.test.ts	* in block body is not a block comment
file_reference	"../../packages/language/test/comment-span-align.test.ts:backticked @reqlan/* is not a block comment"	packages/language/test/comment-span-align.test.ts	* is not a block comment
file_reference	"../../packages/language/test/langium-rust-parse-align.test.ts:fencing_comments"	packages/language/test/langium-rust-parse-align.test.ts	langium-rust-parse-align.test.ts:fencing_comments
file_reference	"../../crates/reqlan-parse/tests/lexer.rs:backticked_slash_star_is_not_a_comment"	crates/reqlan-parse/tests/lexer.rs	lexer.rs:backticked_slash_star_is_not_a_comment
file_reference	"../../crates/reqlan-parse/tests/lexer.rs:quoted_slash_slash_in_body_is_not_a_comment"	crates/reqlan-parse/tests/lexer.rs	lexer.rs:quoted_slash_slash_in_body_is_not_a_comment
file_reference	"../../crates/reqlan-parse/tests/lexer.rs:backticked_slash_slash_in_body_is_not_a_comment"	crates/reqlan-parse/tests/lexer.rs	lexer.rs:backticked_slash_slash_in_body_is_not_a_comment
file_reference	"../../crates/reqlan-parse/tests/lexer.rs:unclosed_backtick_then_slash_slash_is_a_comment"	crates/reqlan-parse/tests/lexer.rs	lexer.rs:unclosed_backtick_then_slash_slash_is_a_comment
file_reference	"../../crates/reqlan-parse/tests/lexer.rs:unclosed_quote_then_slash_slash_is_a_comment"	crates/reqlan-parse/tests/lexer.rs	lexer.rs:unclosed_quote_then_slash_slash_is_a_comment
file_reference	"../../crates/reqlan-index/src/rq_ignore.rs:does_not_treat_marker_inside_backticks_as_a_directive"	crates/reqlan-index/src/rq_ignore.rs	rq_ignore.rs:does_not_treat_marker_inside_backticks_as_a_directive
comment_link	fencing_comments	reqlan rq/language/crates/reqlan-index/src/rq_ignore.rs	//! rq:fencing_comments
comment_link	fencing_comments	reqlan rq/language/crates/reqlan-parse/src/lexer.rs	//! rq:fencing_comments
comment_link	fencing_comments	reqlan rq/language/crates/reqlan-parse/tests/lexer.rs	// rq:fencing_comments
comment_link	fencing_comments	reqlan rq/language/packages/language/scripts/patch-textmate.mjs	* rq:fencing_comments
comment_link	fencing_comments	reqlan rq/language/packages/language/src/reqlan-comment-resolver.ts	* rq:fencing_comments
comment_link	fencing_comments	reqlan rq/language/packages/language/src/reqlan-line-fences.ts	* rq:fencing_comments
comment_link	fencing_comments	reqlan rq/language/packages/language/src/reqlan-token-builder.ts	* rq:fencing_comments
comment_link	fencing_comments	reqlan rq/language/packages/language/test/comment-in-string.test.ts	// rq:fencing_comments
comment_link	fencing_comments	reqlan rq/language/packages/language/test/comment-span-align.test.ts	* rq:fencing_comments
comment_link	fencing_comments	reqlan rq/language/packages/language/test/langium-rust-parse-align.test.ts	* rq:fencing_comments
comment_link	fencing_comments	reqlan rq/language/packages/language/test/parsing.test.ts	// rq:fencing_comments
comment_link	fencing_comments	reqlan rq/language/packages/language/test/references.test.ts	// rq:fencing_comments

Inbound references

Kind	Idea	Path	Snippet
references	comment_span_align	reqlan rq/core_analysis/rust_port.rq	fencing_comments
references	comments	reqlan rq/language/syntax.rq	fencing_comments

Unresolved references

Kind	Idea	Path	Snippet
None

Local graph

Initialising graph…