You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It appears that the VSCode extension supports HTML entity references (e.g. *), and for some HTML elements simply shows their content without any special formatting (e.g. <b>bold</b>).
However, <code> elements are apparently completely omitted, not even their content is shown:
My use case is that I would like to write /** ... */ (a Javadoc comment) in a QLDoc, however */ is recognized as end of the QLDoc. Therefore the only workaround might be to use <code>/** ... */</code>.
But this is not super important, I could probably also just omit */ from my QLDoc comment.
To Reproduce
In a query file write the following QLDoc comment or add it to an existing element
/**
* Test <code>code</code> */ <b>bold</b> <i>italic</i>
*/
Hover over the QLDoc
❌ The text "code" is completely missing from the shown rendered QLDoc
Expected behavior
At least the content of the <code> element should be shown in the rendered QLDoc (similar to how it is the case for <b>)
Or ideally the content of the <code> element is shown and formatted as code
Additional context
The LGTM Query Console seems to support <code> and even formats the text as code in the preview when hovering over a documented element:
The text was updated successfully, but these errors were encountered:
non-javadoc-block-comment.ql now uses raw HTML in the QLDoc. The Query Console
seems to support it, but the VSCode extension does not, see
github/vscode-codeql#794.
Could also omit the closing `*/` from the QLDoc in the future, if necessary.
Vscode doesn't support non-span tags in markdown and we pass the markdown directly to vscode so this will be tricky to support. See microsoft/vscode#110945 for the upstream issue.
Thanks for the information! Feel free to close this issue then if you think VSCode should fix this issue, unless you want to perform some pre-processing.
Describe the bug
According to the language specification QLDoc uses CommonMark, which supports raw HTML.
It appears that the VSCode extension supports HTML entity references (e.g.
*
), and for some HTML elements simply shows their content without any special formatting (e.g.<b>bold</b>
).However,

<code>
elements are apparently completely omitted, not even their content is shown:My use case is that I would like to write
/** ... */
(a Javadoc comment) in a QLDoc, however*/
is recognized as end of the QLDoc. Therefore the only workaround might be to use<code>/** ... */</code>
.But this is not super important, I could probably also just omit
*/
from my QLDoc comment.To Reproduce
❌ The text "code" is completely missing from the shown rendered QLDoc
Expected behavior
<code>
element should be shown in the rendered QLDoc (similar to how it is the case for<b>
)<code>
element is shown and formatted as codeAdditional context

The LGTM Query Console seems to support
<code>
and even formats the text as code in the preview when hovering over a documented element:The text was updated successfully, but these errors were encountered: