VSCode下Kernel-Doc风格注释无法正常显示文档提示的解决方案咨询
在VSCode中无需转换风格即可显示Kernel-Doc注释的方法
针对你提供的Kernel-Doc风格注释代码:
/** * list_add - add a new entry * @new: new entry to be added * @head: list head to add it after * * Insert a new entry after the specified head. * This is good for implementing stacks. */ static inline void list_add(struct list_head *new, struct list_head *head) { __list_add(new, head, head->next); }
VSCode默认无法完整识别Kernel-Doc的@参数标签,导致悬停提示缺失参数说明。以下是无需修改注释风格的解决方法:
方法一:配置C/C++扩展的IntelliSense
VSCode的C/C++扩展支持通过自定义配置兼容Kernel-Doc:
- 打开VSCode设置(快捷键
Ctrl+,),搜索并确保C_Cpp.intelliSenseEngine设置为Default(不要使用Tag Parser,后者对注释解析支持有限)。 - 打开
settings.json(通过设置界面右上角的「打开设置(JSON)」按钮进入),添加以下配置:
这段配置将Kernel-Doc中"C_Cpp.doxygen.enabled": true, "C_Cpp.doxygen.commentPatterns": { "kernelDoc": { "pattern": "/\\*\\*\\s*(\\*\\s+.*?)*\\*/", "tags": { "@new": "param", "@head": "param" // 若有其他Kernel-Doc参数标签,可在此继续添加映射 } } }@参数名格式的标签映射为Doxygen的@param标签,让IntelliSense能够识别并展示参数说明。 - 保存配置后重启VSCode,悬停到
list_add函数上即可看到包含参数说明的完整文档提示。
方法二:安装专门的Kernel-Doc扩展
直接在VSCode扩展市场搜索并安装Kernel Doc Viewer扩展,该扩展专门适配Kernel-Doc风格注释,安装后无需额外配置,悬停函数时就能直接显示完整的Kernel-Doc文档,包括所有参数说明。
内容的提问来源于stack exchange,提问作者parkjbdev
相关产品推荐
相关产品推荐

