VSCode代码注释规范_符合Doxygen标准的注释生成器

陌墨酱_6578

陌墨酱_6578

2026-04-20

813人浏览

原创

doxygen documentation generator 插件需正确配置才能生成标准注释:触发序列应为"/**",光标须位于c/c++符号定义正上方,依赖c/c++扩展提供语义信息,且注释块须紧贴定义无空行,doxyfile中extract_all和input路径需合理设置。

vscode代码注释规范_符合doxygen标准的注释生成器

Doxygen Documentation Generator 插件能直接在 VSCode 里生成符合 Doxygen 标准的注释,但它本身不校验注释是否合法,也不生成最终文档——那得靠系统级 doxygen 命令和正确的 Doxyfile 配置。

为什么输入 /** 后没反应?触发机制被关了或配错了

插件默认只在光标位于函数/结构体/变量定义正上方时才响应 /** + 回车。常见失效原因:

  • doxdocgen.c.triggerSequence 被设成 "/*" 或空值,应保持为 "/**"
  • 当前文件后缀未被识别为 C/C++(比如是 .h 但 VSCode 没激活 C/C++ 扩展),检查右下角语言模式是否显示 C 或 C++
  • 光标不在“可识别符号上方”:例如写在 if 块里、宏展开后的位置、或函数体内而非声明行上方
  • 插件配置中 doxdocgen.generic.language 错设为 python,而当前是 C 文件

函数注释里 @param 缺失或顺序错乱?类型推导依赖语言服务

插件会读取当前光标所在行的函数签名,调用 VSCode 的 C/C++ 扩展提供的语义信息来提取参数名和类型。如果 @param 行缺失或错位,通常是因为:

  • C/C++ 扩展未启用或崩溃(看左下角有没有报错提示)
  • 函数声明跨多行(如参数分行写),插件只解析单行声明;建议把声明写在一行,或手动补全 @param
  • 用了 typedef 类型或宏定义的参数(如 MY_STATUS),插件无法展开,@param 名会为空或错乱
  • doxdocgen.generic.includeTypeAtReturn 设为 false,会导致 @return 不带类型,但不影响 @param 生成

文件头注释不带版权信息?copyrightTag 必须手写进 settings.json

UI 设置界面里填的 Author Name 和 Email 只影响 @author 字段,@copyright 需要显式配置 doxdocgen.file.copyrightTag,且必须是数组格式:

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载
"doxdocgen.file.copyrightTag": [
  "@copyright Copyright (c) {year} YourCompany",
  "@version 1.0.0"
]

注意:{year} 是插件支持的占位符,会自动替换为当前年份;{author} 同理,但前提是 doxdocgen.generic.authorName 已设置。

生成的注释被 Doxygen 忽略?检查注释块位置和 Doxyfile 配置

即使注释语法完全正确,doxygen 命令仍可能跳过它们——最常被忽略的两个点:

  • 注释块必须紧贴符号定义上方,中间不能有空行(/** */ 和 int func(); 之间不能有空白行)
  • Doxyfile 中的 EXTRACT_ALL = NO(默认值),意味着只提取带注释的符号;若想强制提取所有,需改为 YES,但更推荐给每个公开接口补上注释
  • INPUT 路径没包含头文件目录(如只写了 ./src 却漏了 ./include),导致 .h 里的函数声明注释不被扫描

真正卡住人的地方往往不是插件怎么用,而是 doxygen 命令跑起来之后,HTML 输出里某几个函数始终不出现——这时得回头查注释块和定义之间的物理距离,以及 Doxyfile 里那几行看似不起眼的路径和开关设置。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

vscode

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1435

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

3052

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

2029

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1747

8

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

2607

12

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1838

14

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1262

10

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1136

8

vscode设置中文界面不生效解决方法
vscode设置中文界面不生效解决方法

vscode设置中文界面不生效解决方法:安装中文语言包、通过命令面板设置语言、检查 locale.json 设置、重新安装中文语言包、检查 VSCode 版本和更新、排除插件冲突、检查系统语言设置、查看 VSCode 日志和错误消息、重置 VSCode 设置、查看官方文档和社区支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

514

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程