VSCode插件辅助编写中文注释说明文档

陌枫小哥_6806

陌枫小哥_6806

2026-08-06

669人浏览

原创

vscode中/**回车无效是因jsdoc触发需满足语言模式、光标位置等前提:仅js/ts/py有效,光标须在函数声明行或其上空行,py需配置docstring风格;korofileheader最稳但模板变量名须英文;codegeex需登录并设zh-cn;snippet轻量但不解析代码。

vscode插件辅助编写中文注释说明文档

为什么按/**回车没反应?

不是插件坏了,而是 VSCode 的 JSDoc 触发机制有硬性前提:/** 回车生效只在特定语言模式下起作用。常见失效场景包括:右下角语言模式显示为 Plain Text 或未识别类型;光标不在函数声明行(如 function getUser())或其正上方空行;Python 文件未配置 docstring 风格。

实操建议:

  • 先确认右下角语言标识是否为 javascript、typescript 或 python —— 点击它可手动切换
  • Python 用户必须在设置中显式指定 python.docstringGenerator.style 为 google、numpy 或 restructuredtext,否则 """ 回车无效
  • TypeScript 中若用 Document This,解构参数(如 ({ id, name }) => {})和箭头函数表达式体(如 const fn = () => "ok")不会被解析,参数注释会漏掉

koroFileHeader 配置中文文件头与函数注释最稳

它不依赖语言服务,靠模板+变量驱动,对中文支持最直白可靠。关键点在于:模板里字段名(如 $description$)必须用英文,但值可以写中文;变量名不能写成 $功能说明$,否则插件无法替换。

实操建议:

  • 在 settings.json 中添加以下配置(注意双引号转义):
{
  "fileheader.customMade": {
    "Author": "张三",
    "Date": "Do not edit",
    "Description": ""
  },
  "fileheader.configObj": {
    "autoAdd": true,
    "annotationStr": {
      "head": "//",
      "middle": "//",
      "end": "//"
    }
  }
}
  • 新建文件按 Ctrl+Alt+I 插入文件头;光标停在函数定义行(如 function getUser(id) {),按 Ctrl+Alt+T 生成带中文占位的函数注释
  • 若想把 Description 字段改成“功能说明”,模板里仍写 "Description": "$description$",只是人工填写时写中文描述

CodeGeeX 解释代码必须设为 zh-CN

默认解释语言常为英文,不手动切换就得不到中文注释。未登录状态下整个解释功能完全失效,右下角火箭图标不出现即代表不可用。

VSCode
VSCode

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

下载

实操建议:

  • 登录后,在设置中搜索 codegeex explanation language → 选 zh-CN
  • 选中目标代码(建议 ≤50 行)→ 按 Alt+T(macOS 为 Option+T)→ 点 explanation 模板
  • 右键 → CodeGeeX Tool → Add Comment 最省心,但注意:若光标不在选区末尾,注释可能错位到文件顶部
  • 用 /comment 指令更可控——光标落在函数定义行时,它能自动识别签名并生成含 @param、@return 的完整注释

自定义 snippet 轻量但需手动补全

适合固定结构、少量字段的注释模板,比如接口文档头或测试用例说明。它不解析代码结构,纯靠文本替换,所以参数名、返回值类型得自己填。

实操建议:

  • 按 Ctrl+Shift+P → 输入 Configure User Snippets → 选语言(如 javascript)
  • 添加类似这样的片段:
"Chinese Func Header": {
  "prefix": "chdr",
  "body": [
    "/**",
    " * @description $1",
    " * @param {$2} $3 - $4",
    " * @returns {$5} $6",
    " */"
  ],
  "description": "中文函数注释模板"
}
  • 输入 chdr + Tab 即可展开,$1~$6 用 Tab 键跳转补全
  • 缺点明显:不感知类型、不校验参数数量、不自动提取函数签名——复杂函数仍得靠插件

中文注释生成不是“装了插件就完事”,真正卡住人的往往是语言模式、光标位置、模板变量命名这三处细节。尤其当项目混用 TypeScript 解构 + 箭头函数 + 中文描述时,Document This 会静默漏字段,CodeGeeX 若没设 zh-CN 就只吐英文,koroFileHeader 若把 $description$ 写成 $功能说明$ 就永远不替换——这些地方不试一次根本意识不到。

相关文章

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

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

下载

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

相关专题

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

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

2023.06.30

1255

18

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

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

2023.07.21

2652

3

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

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

2024.03.14

1909

12

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

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

2024.03.14

1727

8

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

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

2024.03.15

2587

12

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

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

2024.03.15

1818

14

vscode用途介绍
vscode用途介绍

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

2024.03.15

1242

10

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

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

2024.03.15

1116

8

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

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

2024.03.15

454

5

热门下载

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

精品课程

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