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

Atom函数代码注释使用技巧

酷伟姑娘_4083

酷伟姑娘_4083

发布时间:2026-10-31 06:39:50

|

379人浏览过

|

来源于php中文网

原创

DocBlockr触发需同时满足光标位于函数/方法/变量声明行且语言模式为source.js等支持scope;.vue文件需手动映射text.html.vue到JavaScript,自定义模板仅支持有限变量。

atom函数代码注释使用技巧

DocBlockr 触发失败:光标位置和语言模式必须同时满足

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

常见失效场景包括:

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

参数名错乱或缺失:正则匹配 ≠ AST 解析

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 会自动补全后续字段

Vue 单文件组件中 <script></script> 块不触发:scope 映射是硬门槛

.vue 文件默认被 Atom 识别为 text.html.vue,而 DocBlockr 只在 source.js、source.ts 等 scope 下激活。不映射,就永远不响应。

实操步骤:

  • 打开 Atom → Settings → Packages → docblockr → Language Specific Settings
  • 在 Scope Names 输入框中添加 text.html.vue
  • 在对应 Language 下拉菜单中选 JavaScript(或 TypeScript)
  • 保存后重启 Atom 或重载窗口(Window: Reload)

注意:仅修改 grammar 设置(如右下角点选 JavaScript)无效,必须走 DocBlockr 的 scope 映射配置。

自定义模板填坑:EJS 变量名和执行逻辑都受限

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

关键限制:

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

真正要加公司级字段(如 @internal 或 @license),得去编辑 ~/.atom/packages/docblockr/snippets/javascript.cson 文件,在 docblock 的 body 数组末尾追加新行,而不是靠 template 配置。

热门AI工具

更多
小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

WorkBuddy

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

讯飞绘文

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

Atoms
Atoms Hot

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

DeepSeek

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

Loomy
Loomy Hot

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

豆包大模型

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

相关专题

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

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

9099

2023.11.02

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

60

2026.10.28

Vite 如何搭配 Vue.js
Vite 如何搭配 Vue.js

Vite搭配Vue.js专题汇集创建Vue 3项目、配置开发环境、路径别名、Vue插件、代理、多环境构建与调试的已审核文章,帮助读者完成从初始化到日常开发的配置。

40

2026.10.28

Vite 项目目录怎么看
Vite 项目目录怎么看

Vite项目目录专题汇集入口文件、src源码、public静态资源、路径别名、项目根目录和构建输出目录相关的已审核文章,帮助读者理解各文件夹的用途与引用方式。

120

2026.10.28

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

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

140

2026.10.22

Gradle Wrapper配置教程
Gradle Wrapper配置教程

本专题介绍Gradle Wrapper的基本作用,涵盖文件组成、生成方法、版本配置和任务调用,帮助你理解项目如何使用指定的Gradle版本,减少不同开发环境带来的构建差异。

120

2026.10.22

Golangci-lint检查器使用教程
Golangci-lint检查器使用教程

本专题整理Golangci-lint常用Linters的用途与配置方法,覆盖错误处理、无效代码、安全、复杂度、命名和依赖检查,帮助项目合理选规则。

80

2026.10.22

Gradle怎么构建Java项目
Gradle怎么构建Java项目

本专题介绍Gradle Java项目构建方法,涵盖Java插件配置、依赖声明、源码编译、测试执行和打包检查,帮助你理解各阶段的任务关系,逐步完成项目构建。

40

2026.10.22

PHP时间戳漏洞修复教程
PHP时间戳漏洞修复教程

本专题汇总PHP常见时间戳漏洞,包括2038年溢出、时区漂移、时间戳伪造、重放攻击、时间盲注与日志审计失效等,并给出升级64位环境、使用 DateTimeImmutable、统一UTC、严格超时校验、预处理绑定、hash_equals 比对等修复方案,帮助开发者快速排查和加固时间相关代码。

80

2026.10.22

热门下载

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

精品课程

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

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