在 VS Code 中使用 C/C++，如何在符号的工具提示描述中创建列表和表格？

Question

我正在使用 VS Code 用 C 语言编程。 C/C++ 扩展使您能够创建描述、文档并在将鼠标悬停在符号上时显示它。

    /**
     * @brief General control register
     *
     * @param b15 Reserved
     * @param b14 Disable TXA output and set to high impedance
     * @param b13 Disable TXAN output and set to high impedance
     * @param b12 Xtal frequency: 0 = 12.2880 MHz, 1 = 11.0592 MHz
     * @param b11 Analog loopdown. When used, tx/rx mode settings must be same
     * @param b10 Disable TX/RX fixed compromise equalizer
     * @param b9 Relay drive(RDRVN) output: 0 = VDD, 1 = VSS
     * @param b8 Power up: 0 = power save mode, 1 = normal mode
     * @param b7 Reset. On power on, reset and power up must be set to 1 and wait for at least 20 ms
     * @param b6 Enable nIRQ according to status register
     * @param b5-b0 IRQ mask bits
     * 
     */
    uint16_t generalControl;

目前我正在使用

@param

来描述每个位，但我更喜欢列表（和表格以供将来使用）。我想知道是否可以在 vscode c 中做这样的事情。

这里有一些我试过但没有用的东西。

    /**
     * @brief Transmit mode register
     * 
     * @param b15-b12 TX mode
     * 
     * 
     * - Is list working?
     * -# List item 1
     * -# I don't think so
     * 
     * <table>
     * <tr><td>0000</td><td>Normal mode</td></tr>
     * </table>
     * 
     */
    uint16_t transmitMode;

Answer 1

我很确定一旦 VS Code Cpptools 扩展在其悬停信息中启用降价，这将得到支持。请参阅Markdown 评论支持悬停工具提示显示#6020。在撰写本文时，该问题单被标记为 1.16 发布里程碑的“进行中”。

相关：https://code.visualstudio.com/api/references/vscode-api#Hover。我用 JavaScript 扩展做了一个快速测试，假设使用这个 API，VS 代码支持GitHub markdown 表扩展（或类似的东西）。这与在 Stack Exchange 上实现的标记语法相同。

使用 Markdown 的列表示例（另请参阅文档）：

- foo
- bar
- baz

带有 Markdown 的表格示例：

| hello | goodbye |
|:-----:|:-------:|
| hi    | bye     |