如何设置VSCode使Doxygen一键生成符合CC++标准的函数注释?
- 内容介绍
- 文章标签
- 相关推荐
本文共计915个文字,预计阅读时间需要4分钟。
在VSCode市场中搜索到的同名插件中,只有作者为ms-vscode的插件真正支持C/C++函数注释的上下文识别。第三方插件通常将`@param`字段名硬编码成`param1`和`param2`,而不会读取函数声明中的实际参数名。安装错误后,通过快捷键生成的注释看起来像模板,实际上`@param+a`和函数签名中的`int+a`不一致。Doxygen解析时直接跳过整个块。
安装完务必重启VSCode,否则Ctrl+Win+T(Windows)或Cmd+Option+T(macOS)可能无响应——这不是快捷键冲突,而是插件服务没加载。
函数注释模板必须匹配C/C++语法细节
默认模板用\param和\return,但多数C/C++项目约定用@param和@return。不改的话,生成的注释会被doxygen当成普通文本忽略。
本文共计915个文字,预计阅读时间需要4分钟。
在VSCode市场中搜索到的同名插件中,只有作者为ms-vscode的插件真正支持C/C++函数注释的上下文识别。第三方插件通常将`@param`字段名硬编码成`param1`和`param2`,而不会读取函数声明中的实际参数名。安装错误后,通过快捷键生成的注释看起来像模板,实际上`@param+a`和函数签名中的`int+a`不一致。Doxygen解析时直接跳过整个块。
安装完务必重启VSCode,否则Ctrl+Win+T(Windows)或Cmd+Option+T(macOS)可能无响应——这不是快捷键冲突,而是插件服务没加载。
函数注释模板必须匹配C/C++语法细节
默认模板用\param和\return,但多数C/C++项目约定用@param和@return。不改的话,生成的注释会被doxygen当成普通文本忽略。

