文档生成插件在VSCode中的注释模板设置

陌婷吖_6374

陌婷吖_6374

2026-09-01

896人浏览

原创

vscode中/**回车不生成doxygen注释,主因是语言模式错误、光标位置不当或插件配置不匹配;需确认语言为c/cpp/js、光标在函数声明行上方,并正确配置doxdocgen或korofileheader等插件参数。

文档生成插件在vscode中的注释模板设置

为什么 /** 回车没生成 Doxygen 注释?

不是插件没装,而是 VSCode 的 /** 触发机制只对特定语言生效,且有严格位置要求。常见失效原因包括:

  • 当前文件右下角语言模式显示为 Plain Text 或未识别类型——点击它手动切换成 c、cpp 或 javascript
  • 光标不在函数定义行(如 int foo(int a);)或其正上方空行,而是在函数体内或已有注释中间
  • C/C++ 场景下用了 Doxygen Documentation Generator,但配置项 doxdocgen.c.triggerSequence 被误改成了 /// 或其他值
  • JavaScript/TypeScript 中启用了 Document This,但它不解析箭头函数表达式体(如 const fn = () => {})和解构参数(如 ({ id, name }) => {})

Doxygen Documentation Generator 的关键配置项

这个插件是 C/C++ 项目最稳的 Doxygen 注释生成工具,但默认配置不够贴合中文团队习惯。必须手动调整以下几项:

  • doxdocgen.c.firstLine:设为 "/**"(不能漏掉引号),否则触发失败
  • doxdocgen.c.lastLine:设为 " */"(注意开头空格),保证闭合格式统一
  • doxdocgen.c.commentPrefix:设为 " * "(星号+空格),避免生成 *** 或缩进错位
  • doxdocgen.c.fileOrder:控制文件头字段顺序,例如 ["@file", "@brief", "@author", "@date"],中文作者名可直接写进 @author 值里
  • doxdocgen.cpp.ctorText 和 doxdocgen.c.getterText 这类智能文本字段,若想用中文,直接填 "创建一个 {name} 对象" 即可,插件支持 UTF-8

koroFileHeader 怎么配出 Doxygen 风格注释?

它不依赖语言服务,适合需要跨语言统一风格的场景,但模板变量名必须是英文(如 $description$),值可以写中文。要生成类似 Doxygen 的 @param 结构,得这样配:

VSCode
VSCode

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

下载
{
  "fileheader.customMade": {
    "Author": "李四",
    "Date": "Do not edit",
    "Description": ""
  },
  "fileheader.configObj": {
    "autoAdd": true,
    "annotationStr": {
      "head": "/**",
      "middle": " * ",
      "end": " */"
    },
    "functionTemplate": {
      "before": "",
      "after": "",
      "params": [
        " * @param {$1} {$2} - ",
        " * @returns {$3} "
      ]
    }
  }
}
  • annotationStr.head 和 .end 决定注释块起止符,必须匹配 Doxygen 解析器要求
  • functionTemplate.params 数组里每项对应一个参数占位,$1 是参数名,$2 是类型(需手动补),$3 是返回值类型
  • 若项目用 C++ 模板函数,functionTemplate 无法自动推导 template<typename t></typename>,得靠人工加一行 * @tparam T

用户代码片段(Snippets)生成 Doxygen 注释的边界在哪?

Snippets 最轻量、最可控,但本质是纯文本替换,不读取 AST,所以没有参数自动提取能力。适合固定结构,比如文件头或标准函数签名:

  • 在 cpp.json 里加一个 prefix 为 dh 的片段,body 写成:["/**", " * @file ${TM_FILENAME}", " * @brief ${1:功能简述}", " * @author ${TM_AUTHOR}", " * @date ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE}", " */", "${0}"]
  • ${TM_AUTHOR} 必须提前在 VSCode 设置中通过 files.author 填好,否则留空
  • 无法为 void process(std::vector<int>& arr, const std::string& msg)</int> 自动生成两个 @param 行——得靠插件(如 Doxygen Documentation Generator 或 koroFileHeader)来解析函数签名
  • 如果团队里有人用 macOS、有人用 Windows,${CURRENT_HOUR}:${CURRENT_MINUTE} 会因系统时区设置不同而出现时间偏差,建议只用日期部分

真正难的不是生成注释,而是让注释持续准确。函数签名一改,所有 @param 就可能过期;@brief 写成“处理数据”等于没写。模板再自动,也绕不开人对语义的理解。

相关文章

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

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

下载

相关标签:

vscode插件设置 vscode

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

相关专题

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

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

2023.06.30

1195

18

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

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

2023.07.21

2412

3

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

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

2024.03.14

1849

12

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

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

2024.03.14

1687

8

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

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

2024.03.15

2567

12

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

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

2024.03.15

1798

14

vscode用途介绍
vscode用途介绍

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

2024.03.15

1222

10

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

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

2024.03.15

1096

8

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

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

2024.03.15

434

5

热门下载

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

精品课程

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