VSCode中如何让Doxygen注释内的HTML标签正确渲染？

开发者阿泽

2026-7-20

在VSCode中让Doxygen注释的HTML标签正确渲染的配置方法

要让VSCode正确解析Doxygen风格注释中的HTML标签，只需针对官方Microsoft C/C++插件做以下配置：

步骤1：开启HTML渲染支持

打开VSCode设置界面（快捷键：Ctrl+, / Cmd+,），搜索并设置：

C_Cpp.doxygen.preferences.renderHtml：设为true
C_Cpp.doxygen.enable：确保该选项为true（默认已开启，若被关闭需重新启用）

步骤2：优化注释写法（可选）

你当前注释中使用了HTML实体转义（如<代替<），虽然开启渲染后插件会自动解析这些实体，但直接使用原生HTML标签（如<code>、<ul>、<li>）会让注释更易读，同时渲染效果一致。调整后的示例注释可改为：

/*!
 * \brief Multiply two integers
 *
 * \example <code> int x = myFunc(5,7); </code>
 *
 * \param x first argument
 * \param y second argument
 *
 * \note An example of notes.<br/>. A list is as follows:
 * <ul>
 *  <li>First element</li>
 *  <li>Second element</li>
 * </ul>
 *
 * \return the product of x and y
 */
int myFunc(int x, int y)
{
    return x * y;
}