在VS Code的C/C++开发中，如何为符号悬停提示添加列表与表格？

VS Code的C/C++扩展基于Doxygen解析注释，需遵循Doxygen语法规则实现列表和表格，直接写Markdown原生语法不会生效，以下是具体实现方法：

1. 列表的正确写法 #

Doxygen支持无序列表和有序列表，两种格式都能被VS Code悬停提示正确渲染：

无序列表示例 #

/**
 * @brief Transmit mode register
 * 
 * @param b15-b12 TX mode，包含以下子模式：
 * - 0000: Normal mode
 * - 0001: Low power mode
 * - 0010: Test mode
 */
uint16_t transmitMode;

有序列表示例 #

/**
 * @brief 寄存器配置步骤
 * 
 * 初始化该寄存器需要按以下顺序操作：
 * 1. 置位b8（Power up）为1
 * 2. 置位b7（Reset）为1并等待至少20ms
 * 3. 根据需求配置b15-b0的其他位
 */
uint16_t generalControl;

2. 表格的正确写法 #

Doxygen支持直接使用HTML表格，无需转义标签，VS Code悬停提示会正确解析渲染：

/**
 * @brief Transmit mode register
 * 
 * @param b15-b12 TX mode对应表：
 * <table>
 *   <tr>
 *     <th>位值</th>
 *     <th>模式说明</th>
 *   </tr>
 *   <tr>
 *     <td>0000</td>
 *     <td>Normal mode</td>
 *   </tr>
 *   <tr>
 *     <td>0001</td>
 *     <td>Low power mode</td>
 *   </tr>
 *   <tr>
 *     <td>0010</td>
 *     <td>Test mode</td>
 *   </tr>
 * </table>
 */
uint16_t transmitMode;

也可使用Doxygen原生表格语法（@table/@row/@entry标签），但HTML表格写法更直观灵活。

无效写法的原因 #

你之前的尝试未生效的核心问题：

• Markdown列表：C/C++扩展注释解析依赖Doxygen，不直接兼容Markdown列表语法，必须用Doxygen支持的格式
• 转义HTML标签：<table>这类转义字符会被Doxygen当作普通文本处理，直接写<table>即可正常解析

内容的提问来源于stack exchange，提问作者MarkSouls