Document support code annotation comment chars

[cderv]

Following question at #13540

I wonder if we should try add a callout collapsed by default at https://quarto.org/docs/authoring/code-annotation.html#annotation-syntax

and try to have its content synced to

quarto-cli/src/resources/filters/modules/constants.lua

Lines 75 to 135 in 932e21c

	-- for a given language, the comment character(s)
	local kLangCommentChars = {
	r = {"#"},
	python = {"#"},
	julia = {"#"},
	scala = {"//"},
	matlab = {"%"},
	csharp = {"//"},
	fsharp = {"//"},
	c = {"/*", "*/"},
	css = {"/*", "*/"},
	sas = {"*", ";"},
	powershell = {"#"},
	bash = {"#"},
	sql = {"--"},
	mysql = {"--"},
	psql = {"--"},
	lua = {"--"},
	cpp = {"//"},
	cc = {"//"},
	stan = {"#"},
	octave = {"#"},
	fortran = {"!"},
	fortran95 = {"!"},
	awk = {"#"},
	gawk = {"#"},
	stata = {"*"},
	java = {"//"},
	groovy = {"//"},
	sed = {"#"},
	perl = {"#"},
	ruby = {"#"},
	tikz = {"%"},
	js = {"//"},
	d3 = {"//"},
	node = {"//"},
	sass = {"//"},
	scss = {"//"},
	coffee = {"#"},
	go = {"//"},
	asy = {"//"},
	haskell = {"--"},
	dot = {"//"},
	mermaid = {"%%"},
	apl = {"⍝"},
	yaml = {"#"},
	json = {"//"},
	latex = {"%"},
	typescript = {"//"},
	swift = { "//" },
	javascript = { "//"},
	elm = { "#" },
	vhdl = { "--"},
	html = { "<!--", "-->"},
	markdown = {"<!--", "-->"},
	gap = { "#" },
	dockerfile = { "#" },
	ocaml = { "(*", "*)"},
	rust = { "// "}
	}
	local kDefaultCodeAnnotationComment = {"#"}

This would be an improvement. But we could also add a footnote (or margin note) for url to where to look in the code on github.

[cscheid]

We also have multiple versions of this list (in Lua and TS at least). We should consolidate that, and ideally derive our docs automatically from the consolidated version, so that updates are automatically tracked.

[cderv]

Good idea!

Hopefully we do use the same character sets for all features !

[mcanouil]

And also on the VSCode extension side unfortunately.

[cderv]

Oh good reminder: We do have a list in there too thanks
https://github.com/quarto-dev/quarto/blob/abf1139a41c79e800ca87c08f8d6a366605dcc06/apps/vscode/src/providers/option.ts#L105-L145

So maybe this should be exposed in a way similar of how we exposed schema tools for yaml validation 🤔 ?

[mcanouil]

If I recall properly they are several lists in the extension.

Edit: it's indirectly in the extension

• https://github.com/quarto-dev/quarto/blob/abf1139a41c79e800ca87c08f8d6a366605dcc06/packages/core/src/jupyter/options.ts