讲师中心 微信公众号
AI工具推荐 视频效率加速

Atom怎么给JS代码写规范注释

风辰同学_8645

风辰同学_8645

发布时间:2026-10-25 07:58:32

|

806人浏览过

|

来源于php中文网

原创

DocBlockr仅在光标位于函数/变量声明行且语言模式为source.js等支持scope时触发;.vue需映射text.html.vue到source.js;箭头函数、解构、TS类型需手动补全注释;@author等需修改snippets文件;块注释需绑定editor:toggle-block-comment。

atom怎么给js代码写规范注释

DocBlockr 触发失败?先看光标和语言模式

DocBlockr 不是“输 /** 就出注释”,它只在两个条件同时满足时才工作:光标必须落在函数/变量声明行的任意位置(比如 function foo(a, b) 这整行),且 Atom 右下角显示的语言模式必须是它支持的 scope,例如 source.js 或 source.jsx。常见失效场景包括:

  • 光标停在空行、函数体内部或参数括号里——它不向上/向下查找最近的函数
  • .vue 文件的 <script> 块默认是 text.html.vue,不在 DocBlockr 激活列表里;需进 Settings → Packages → DocBlockr → Language Specific Settings,把 text.html.vue 映射到 source.js
  • 用 .ts、.jsx 等扩展名时,右下角若显示 JavaScript (Babel) 或 TypeScript 是 OK 的,但若显示 Plain text,按 Ctrl+Shift+P → 输入 Grammar: Set Language 手动切换

箭头函数、解构、TS 类型怎么写注释

DocBlockr 不解析 AST,只靠正则从函数签名字符串里“抠”参数名,所以对现代 JS 语法支持有限:

  • const fn = (a, b) => {} 默认不触发;得写成声明式 const fn = function(a, b) {},或装 docblockr-js 插件
  • function f({ x }, [y]) 会被识别为两个参数 { x } 和 [y],不会进一步拆解;@param {Object} options 后需手动补 @property {string} options.x
  • 带默认值的 function g(a = 1, b = 'test'),正则可能截断为 a 和 b,但丢掉默认值部分——这是设计如此,不是 bug
  • TypeScript 类型标注如 (a: string, b?: number) 完全被忽略;@param 类型得手敲,比如 @param {string} a

怎么让 @author、@since 自动填上

DocBlockr 自带模板只认固定变量:description、author、date、return、params。想加 @author 或 @since,不能靠全局设置,得改 snippet 文件:

Json Repair Kit
Json Repair Kit

使用 Node.js 评估修复格式错误的 JSON,自动纠正尾随逗号、单引号、未加引号的键等常见问题,实现文件规范化。

下载
  • 路径是 ~/.atom/packages/docblockr/snippets/javascript.cson(macOS/Linux)或 %USERPROFILE%\.atom\packages\docblockr\snippets\javascript.cson(Windows)
  • 找到 docblock 对应的 body 数组,在末尾追加一行:'@author ${1:your.name@example.com}'
  • author 值取自 Atom 全局设置里的 Core > Author Name,不是 Git config 的 user.name
  • 别写 这类 JS 判断——DocBlockr 不执行逻辑,只会原样输出

块注释和行注释快捷键怎么配才不翻车

Ctrl+/ 默认调用的是 editor:toggle-line-comments,行为完全由当前 grammar 决定。想用 /* */ 块注释,得手动绑定 editor:toggle-block-comment:

  • 打开 Config → Open Config Folder,编辑 keymap.cson
  • 加入(以 JS/JSX/TS 为例):
    '.source.js, .source.jsx, .source.ts, .source.tsx':
      'ctrl-alt-/': 'editor:toggle-block-comment'
  • scope 必须精确匹配;查当前真实 scope 的方法:Ctrl+Shift+P → Editor: Log Cursor Scope,看控制台输出(如 source.js.jsx meta.function.js)
  • 别用泛用选择器如 *,否则可能在设置页或终端误触发

最常被忽略的一点:DocBlockr 的参数提取能力是正则级的,不是语法级的。哪怕你把函数写得再规范,只要括号内有换行、多空格、注释符号或非 ASCII 字符,就可能崩。真要 100% 控制字段,不如光标停在函数名后直接敲 @param 再 Tab —— 它会自动补全后续字段,比等自动生成更稳。

热门AI工具

更多
Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

相关专题

更多
js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

4476

2023.06.20

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1355

2023.07.28

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

1778

2023.08.03

js是什么意思
js是什么意思

JS是JavaScript的缩写,它是一种广泛应用于网页开发的脚本语言。JavaScript是一种解释性的、基于对象和事件驱动的编程语言,通常用于为网页增加交互性和动态性。它可以在网页上实现复杂的功能和效果,如表单验证、页面元素操作、动画效果、数据交互等。

10023

2023.08.17

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

980

2023.09.01

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

2784

2023.09.04

Js中concat和push的区别
Js中concat和push的区别

Js中concat和push的区别:1、concat用于将两个或多个数组合并成一个新数组,并返回这个新数组,而push用于向数组的末尾添加一个或多个元素,并返回修改后的数组的新长度;2、concat不会修改原始数组,是创建新的数组,而push会修改原数组,将新元素添加到原数组的末尾等等。本专题为大家提供concat和push相关的文章、下载、课程内容,供大家免费下载体验。

1569

2023.09.14

js截取字符串的方法介绍
js截取字符串的方法介绍

JavaScript字符串截取方法,包括substring、slice、substr、charAt和split方法。这些方法可以根据具体需求,灵活地截取字符串的不同部分。在实际开发中,根据具体情况选择合适的方法进行字符串截取,能够提高代码的效率和可读性 。

4789

2023.09.21

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

20

2026.10.22

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21.1万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn