Sublime代码块怎么生成函数注释

云明君_9781

云明君_9781

2026-11-12

268人浏览

原创

DocBlockr 正确安装并启用后,新建 .js 文件输入 function foo(a, b) {},光标置于其正上方空行,输入 /** 后按 Enter,若生成含 @param a 和 @param b 的注释块即成功。

sublime代码块怎么生成函数注释

装对插件、设对语法、光标放对位置,/** + Enter 就能出带 @param/@return 的注释块;其他方式基本都不可靠。

怎么确认 DocBlockr 装对了且能用

别信“搜到就装”,Package Control 里有多个叫 DocBlockr 的包,只有 nikhilm 维护的 sublimetext-docblockr 是当前唯一稳定可用的版本。

  • 用 Ctrl+Shift+P(Mac 为 Cmd+Shift+P)打开命令面板,输入 Package Control: Install Package
  • 等列表加载完再搜 DocBlockr,认准作者是 nikhilm,GitHub 仓库名是 sublimetext-docblockr
  • 装完必须重启 Sublime,否则 docblockr 命令不注册,/** 按了也没反应
  • 验证:新建一个 .js 文件,写 function foo(a, b) {},光标停在函数上方空行,输入 /** 后按 Enter —— 若生成含 @param 的块,说明成功

为什么 /** + Enter 没反应

90% 是环境没配准,不是插件坏了。它不看文件后缀,只认右下角显示的语法名。

  • 右下角必须显示 JavaScript、PHP、Python 等支持语言,不能是 Plain Text 或 Unsupported syntax(点它手动切换)
  • 光标必须在函数定义行(如 function bar() { 或 def baz():)任意位置,或其正上方**紧邻的空行**;在函数体内部、变量行、已有注释行都不触发
  • Enter 是默认触发键,不是 Tab;Tab 只在注释生成后用于跳字段
  • 检查是否有插件(比如 Emmet)劫持 Enter 行为;可临时禁用其他插件测试
  • 进 Preferences → Package Settings → DocBlockr → Settings – User,确认 "auto_indent": true 没被设成 false

参数和类型怎么自动填出来

DocBlockr 不解析 AST,只靠正则粗略匹配括号内文本,所以对复杂写法支持很弱。

Convai Technologies Inc.
Convai Technologies Inc.

Convai是一款为游戏和 XR 世界创建可对话 AI 角色的虚拟角色平台。

下载
  • 支持的函数格式包括:function name()、const name = function()、class A { method() {} }、def method(self):
  • 箭头函数 const fn = (a, b) => {} 原生不识别,得改写成 const fn = function(a, b) {} 或额外配置 jsdocs_extra_tags
  • 解构参数如 ({ a }, [b]) 通常只识别出 { a } 和 [b],不会拆解对象/数组结构
  • 类型提示(如 TypeScript 的 a: string、PHP 的 string $a)仅部分支持:PHP 能提取 {string},JS/TS 需开启 "jsdoc_enable_types": true 才尝试推测,但不准
  • 最稳的方式是:在用户设置里补全 "jsdoc_template",例如加一行 "@param {string} $1" 占位,避免每次手敲

生成后怎么高效编辑字段

生成的注释块不是终点,而是起点;字段跳转逻辑容易卡住,得知道它怎么走。

  • 首次生成后,光标默认停在 @description 区域;按 Tab 依次跳到每个 @param、@return、@throws
  • 每个 @param 行末尾有 {type} 占位符,删掉即可写具体类型(如 {string}),留空也合法
  • 如果 Tab 卡住或跳过某行,大概率是 Emmet 或 AutoFileName 类插件劫持了 Tab 键;可在 Preferences → Key Bindings 查看绑定冲突
  • 若想统一加 @author 或 @date,直接在 Settings – User 里加 "author_tag" 和 "date_format" 字段,别靠手补

真正麻烦的从来不是生成动作本身,而是函数签名稍一复杂(比如解构+默认值+泛型),@param 就开始漏、错、乱序——这时候别硬等插件猜对,手动补比调试更省时间。

相关文章

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

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

下载

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

相关专题

更多
Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

2026.11.06

60

12

Postman请求头Headers怎么设置
Postman请求头Headers怎么设置

围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。

2026.11.06

40

13

Postman接口请求发送教程
Postman接口请求发送教程

详细介绍Postman接口请求的创建与发送方法,涵盖GET和POST请求、URL配置、请求参数、Headers请求头、Body请求体设置以及响应结果查看,帮助用户掌握Postman接口请求的完整操作流程。

2026.11.06

40

10

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

2026.11.05

60

12

DBeaver安全防护教程大全
DBeaver安全防护教程大全

DBeaver安全防护专题,围绕数据库连接安全、账号密码保护和访问权限管理展开,整理SSL/TLS加密连接、SSH隧道、数据库凭据保存及证书验证等配置方法,同时介绍敏感信息保护、远程连接风险和高权限账号使用等注意事项,帮助用户提高数据库日常管理的安全性。

2026.11.05

60

12

DBeaver连接创建与配置教程
DBeaver连接创建与配置教程

本专题聚焦DBeaver数据库连接配置与管理,覆盖从新建连接、选择数据库类型到填写连接参数和验证连接的完整流程。针对MySQL、PostgreSQL、SQL Server等常见数据库,整理相应的连接设置方法,并提供驱动缺失、认证失败和连接异常等问题的排查方向。

2026.11.04

60

16

XORM框架结构体映射与表结构同步
XORM框架结构体映射与表结构同步

本专题围绕XORM框架的结构体映射展开,说明表名与字段的命名策略、xorm标签常用属性、主键自增与时间字段自动填充,并演示Sync2自动建表、增量字段升级、索引声明与反向生成结构体的完整流程。

2026.11.04

60

15

XORM框架安装配置与数据库连接
XORM框架安装配置与数据库连接

本专题聚焦XORM框架的配置与连接环节,拆解MySQL、PostgreSQL、SQLite、SQL Server的DSN写法与驱动选择,讲清连接池参数、多数据源拆分、读写分离与超时重连的处理方式,并补充容器与兼容数据库的适配经验。

2026.11.04

60

15

XORM框架安装配置与数据库连接
XORM框架安装配置与数据库连接

本专题聚焦XORM框架的配置与连接环节,拆解MySQL、PostgreSQL、SQLite、SQL Server的DSN写法与驱动选择,讲清连接池参数、多数据源拆分、读写分离与超时重连的处理方式,并补充容器与兼容数据库的适配经验。

2026.11.04

0

16

热门下载

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

精品课程

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