QLDoc view omits `<code>` HTML elements

未关闭

#794 创建于 2021年3月20日 2 条评论 0 个 reaction 已指派 0 人在 GitHub 查看

还没有人认领这个 Issue。

评估

难度: 3/5
预计耗时: 1-2 天
新手友好度: 35/100

Issue 类型: 缺陷
描述清晰度: 基本清楚
活跃度: 停滞
技术栈: typescript
领域: documentation

调研方向

在 VSCode 扩展中将鼠标悬停在提供的 QLDoc 示例上，在查询文件中复现该问题。跟踪 QLDoc 的悬停/渲染路径，以确定为何会省略 code 元素的内容。完成标准是内容出现在渲染后的 QLDoc 中，最好带有代码格式，同时不影响其他显示的 HTML 元素。

由索引模型根据 Issue 内容生成。

描述

bug VSCode

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. &ast;), and for some HTML elements simply shows their content without any special formatting (e.g. bold).

However, <code> elements are apparently completely omitted, not even their content is shown:
QLDoc VSCode extension screenshot

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>/** ... &ast;/</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> &ast;/ bold italic
 */
```
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 )
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:
Query Console QLDoc screenshot