Eclipse CDT是否支持反斜杠前缀的Doxygen标签?如何配置?
配置说明
Eclipse CDT 完全支持反斜杠前缀风格的Doxygen文档标签,可通过内置设置快速切换配置,无需安装第三方组件
基础支持性说明
- Doxygen工具本身原生兼容
@和\两种前缀的标签语法,你当前使用的2020-12 (4.18.0)版本CDT,从设计上就完整适配两种风格的标签识别,不会出现语法不兼容问题 - 两种标签风格可实现完全等价的功能:CDT可正确识别反斜杠前缀标签的语法高亮、代码补全、注释关联、悬停文档预览全流程能力
具体配置调整步骤
配置入口就对应CDT编辑器的文档设置页面,操作路径如下:
- 打开顶部菜单栏的偏好设置入口:Windows/Linux系统为
Window -> Preferences,macOS系统为Eclipse -> Settings - 依次展开左侧导航路径:
C/C++ -> Editor -> Documentation - 在页面的标签风格选择区域,将当前默认选中的
Javadoc (@...)选项,切换为Doxygen (\...)选项 - 按需勾选下方的配套功能项:
- 自动生成文档注释时强制使用反斜杠前缀,避免新建注释块时默认带出
@开头的标签 - 识别已有注释块中的反斜杠标签内容,用于代码悬停时的文档预览
- 自动生成文档注释时强制使用反斜杠前缀,避免新建注释块时默认带出
- 点击「Apply and Close」保存设置,所有配置会立即对新开的编辑窗口生效
生效后的实际表现
- 触发函数/结构体的自动注释生成快捷键时,输出的注释块会默认使用
\brief、\param、\return等反斜杠前缀标签 - 编辑器会对反斜杠开头的Doxygen标签应用专属语法高亮,不会将其判定为普通注释文本
- 鼠标悬停在关联的函数、结构体元素上时,可正确读取注释块中所有反斜杠标签对应的说明内容,不会出现文档解析失败、关联丢失的问题
补充提示:即使现有代码的注释块中存在
@和\前缀标签混用的内容(比如你示例中混写的@return标签),也不需要手动批量修改,CDT的文档解析模块支持两种前缀的混合识别,不会因为标签前缀差异中断注释和代码元素的关联。
内容的提问来源于stack exchange,提问作者ndarkness
相关产品推荐
相关产品推荐

