Atom编辑器中docblockr插件自动生成代码注释的方法

雨强酱_5586

雨强酱_5586

2026-06-23

1007人浏览

原创

docblockr仅在光标位于函数/方法/变量声明行且语言模式为source.js、source.php等支持scope时触发;.vue文件需手动映射text.html.vue到source.js,正则解析参数名不支持箭头函数、解构及类型标注。

atom编辑器中docblockr插件自动生成代码注释的方法

光标位置和文件类型必须同时满足才能触发

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

  • 光标停在空行或函数体内部——它不识别“下方最近的函数”,只认当前行
  • .vue 文件中 <script></script> 块默认是 text.html.vue,不在 DocBlockr 激活列表里;需手动在设置里把 text.html.vue 映射到 source.js
  • 用 .inc、.ctp 等非标准后缀时,得进 Atom Settings → Packages → DocBlockr → Language Specific Settings 手动加 scope 映射
  • 同时启用多个 snippets 插件(如 autocomplete-plus)可能劫持 /** 输入,建议临时禁用排查

参数名错乱或缺失,本质是正则匹配失败

DocBlockr 不解析 AST,也不读 TypeScript 类型或 PHP 8 返回类型,它靠正则从函数签名字符串里“抠”参数名。一旦格式不规整,就容易崩:

  • PHP 中 function test($a , $b = null) 的多余空格会让正则截断为 $a 和 $b,但丢掉 = null 部分——这是设计如此,不是 bug
  • JavaScript 箭头函数 const fn = (a, b) => {} 默认不支持;得改写成 function fn(a, b) {} 或装 docblockr-js 扩展
  • 解构参数 function f({ x }, [y]) 会被识别为两个参数 { x } 和 [y],不会进一步拆解
  • 想强制指定参数名?直接手敲 @param {string} username 再按 Tab,DocBlockr 会自动补全后续字段

自定义模板必须严格遵循 EJS + 固定变量名

想加 @author、@since 或自动填日期,不能随便写 JS 逻辑——DocBlockr 只做静态替换,且只认几个硬编码变量:

Felo
Felo

Felo是一款结合 AI 搜索、实时翻译、研究整理和内容生成的多语言智能工具。

下载
  • 模板填在 Atom Settings → Packages → DocBlockr → Template 输入框里,内容类似:
    /**\n * \n * @author \n * @since \n */
  • 可用变量仅限:description、author、date、return、params;多一个 version 或 copyright 都无效
  • author 值取自 Atom 全局设置里的 Core > Author Name,不是 Git config 的 user.name
  • 别写 这类判断——DocBlockr 不执行 JS,只会原样输出

为什么 Vue 单文件组件里 <script></script> 块没反应

根本原因是 Atom 把 .vue 文件整体识别为 text.html.vue,而 DocBlockr 默认只监听 source.js、source.ts 等 scope。它不关心你写在哪块标签里,只看当前编辑器的 language mode。

  • 临时方案:点右下角语言模式,手动切换成 JavaScript(会丢失 Vue 语法高亮)
  • 长期方案:进 Atom Settings → Packages → DocBlockr → Language Specific Settings,添加一条:
    "text.html.vue": ["source.js"]
  • 注意:这个映射只对 <script></script> 块生效;<template></template> 和 <style></style> 仍不支持,别白费劲

最常被忽略的其实是 scope 映射和正则边界——它不智能,只机械匹配。写法越贴近传统函数声明,成功率越高;一上箭头函数、解构、类型标注,就得接受手动补全或换工具。

相关文章

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

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

下载

相关标签:

atom代码注释

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

相关专题

更多
c语言编程软件有哪些
c语言编程软件有哪些

c语言编程软件有GCC、Clang、Microsoft Visual Studio、Eclipse、NetBeans、Dev-C++、Code::Blocks、KDevelop、Sublime Text和Atom。更多关于c语言编程软件的问题详情请看本专题的文章。php中文网欢迎大家前来学习。

2023.11.02

6919

18

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

2026.09.23

20

15

Buffalo框架路由与请求处理实操指南
Buffalo框架路由与请求处理实操指南

本专题讲解Buffalo框架路由与请求处理机制,涵盖路由注册与分组、资源路由、Handler编写规范、Context上下文方法、参数绑定、中间件编写挂载、Session与Cookie读写、Flash消息及错误页面定制方法。

2026.09.23

0

15

Buffalo框架零基础入门教程
Buffalo框架零基础入门教程

本专题整理Buffalo框架入门内容,涵盖Go环境准备、buffalo CLI安装、新项目生成、目录结构说明、dev热加载启动、数据库连接配置与常见报错排查,帮助新手按约定优于配置的思路跑通第一个Buffalo框架应用。

2026.09.23

20

15

Conan创建软件包配方指南
Conan创建软件包配方指南

本专题介绍通过conanfile.py创建软件包的方法,讲解包名、版本、依赖和构建设置等基础信息,以及source、build、package、package_info等常用方法的作用及编写思路。

2026.09.22

0

12

Conan二进制包配置指南
Conan二进制包配置指南

本专题介绍Conan根据操作系统、编译器、架构和构建类型生成二进制包的方法,讲解Profile、Settings、Options及Package ID的作用,帮助管理不同平台和编译环境下的包版本。

2026.09.22

20

13

Conan私有仓库搭建教程
Conan私有仓库搭建教程

本专题系统的讲解Conan私有仓库的搭建流程,涵盖仓库服务部署、存储目录配置、用户认证、权限划分和远程地址添加,并介绍内部C++依赖包的上传、下载及版本维护方法。

2026.09.22

20

19

loomy官网入口地址合集
loomy官网入口地址合集

本专题汇总了 Loomy 桌面 AI 助理的官方入口地址合集及使用指南。提供 macOS 与 Windows 客户端下载 。Loomy 是讯飞推出的桌面级 AI 工作搭子,支持文件整理、数据分析、网页操作及通过飞书/钉钉远程操控电脑,助你高效完成本地办公任务 。

2026.09.22

20

19

NumPy常见函数使用方法
NumPy常见函数使用方法

本专题整理 NumPy 常见函数使用方法相关教程,覆盖函数大全、参数用法、数组运算、统计聚合、排序处理、where 条件筛选、linspace 创建数列等常用场景,帮助读者快速掌握 NumPy 函数调用思路和实际数据处理技巧。

2026.09.22

0

21

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.2万人学习