Sublime Text如何使用DocBlockr插件?一键生成标准注释文档

云辰酱_4976

云辰酱_4976

2026-10-02

915人浏览

原创

装错插件、语法模式不对、光标位置偏移是docblockr失效主因;必须安装社区维护分支sublimetext-docblockr,语法设为javascript等支持语言,光标置于函数定义行或其正上方空行,输入/**后按enter才生效。

sublime text如何使用docblockr插件?一键生成标准注释文档

装错插件、语法模式不对、光标位置偏移——这三样占了 DocBlockr 失效的 90% 以上。 装对了就能用,根本不需要“一键”玄学操作。

怎么装才不白装

搜 DocBlockr 直接安装,大概率装的是作者已停更的旧版(作者不是 nikhilm),/** + Enter 就是摆设。

  • 必须用 Package Control 安装社区维护分支:按 Ctrl+Shift+P(Mac 为 Cmd+Shift+P),输 Package Control: Install Package,搜 sublimetext-docblockr(GitHub 仓库名)
  • 装完建议重启 Sublime Text,部分版本不重启不加载新插件
  • 验证是否生效:新建 .js 文件,写 function foo(a, b) {},光标停在函数上方空行,输入 /** 后按 Enter —— 若生成带 @param 的块,说明装对了

为什么 /** + Enter 没反应

不是插件坏了,而是环境没配准。右下角语法必须是 JavaScript、PHP、Python 等支持语言,不能是 Plain Text;光标必须在函数定义行(如 function bar() 或 def baz():)任意位置,或其正上方空行。

  • 在函数体里、变量行、已有注释行、<template></template> 区域(.vue 文件中)都不触发
  • Enter 是触发键,Tab 只用于生成后跳字段,别混淆
  • 检查是否有其他插件(如 Emmet)劫持了 Enter 行为,可临时禁用验证
  • 进 Preferences → Package Settings → DocBlockr → Settings – User,确认 "auto_indent": true 没被设为 false

@param 怎么自动带 {type} 占位符

默认模板不带类型占位符,@param 后面永远是空的。要让它自动填 {string} 或 {number},必须手动配模板。

Sublime Text Build Linux版
Sublime Text Build Linux版

Sublime Text Linux x86-64 deb 安装包。官方也提供 rpm、tar.xz 和软件源安装方式。

下载
  • 进 Preferences → Package Settings → DocBlockr → Settings – User
  • 添加 "jsdoc_template" 字段,例如 JavaScript 常用配置:
{
  "jsdoc_template": [
    "/**",
    " * ${1:description}",
    "${2: * @param {${3:type}} ${4:name} ${5:description}}",
    "${6: * @return {${7:type}} ${8:description}}",
    " */"
  ]
}

保存后,/** + Enter 就会带占位符,光标停在描述处,Tab 可顺次跳转。

箭头函数、TypeScript、解构参数为啥不识别

DocBlockr 不跑代码、不读类型系统,只靠正则粗略匹配形参名。所有依赖类型注解或复杂语法的写法,它基本都解析不了。

  • const fn = (a, b) => {}:原生不支持,得改写为 function fn(a, b) {} 或额外配 jsdocs_extra_tags
  • function f({ x }, [y] = []):可能只识别出 { x } 和 [y],不拆结构
  • def g(x: int) -> str: 中的 int 和 str 不会被自动填进 @param {int} 或 @return {str}
  • function h(): ?string 中的 ?string 不会转成 @return string|null

真正容易被忽略的是作用域(scope)匹配机制:Sublime 不看文件后缀,而是看光标所在位置的实际语法 scope。比如 .vue 文件里 <script></script> 区域能触发 DocBlockr,但 <template></template> 区域完全没反应——这不是插件问题,是 scope 没覆盖到。

相关文章

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

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

下载

相关标签:

sublime sublime text

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

相关专题

更多
LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

2026.09.30

20

10

LLVM RISC-V参数配置教程
LLVM RISC-V参数配置教程

本专题介绍LLVM对RISC-V基础ISA和扩展的支持方式,涵盖RV32、RV64、标准扩展、实验性扩展、厂商扩展、-menable-experimental-extensions和版本差异。

2026.09.30

40

14

LLVM IR中间表示入门指南
LLVM IR中间表示入门指南

本专题整理LLVM IR的核心概念,包括中间表示作用、模块结构、函数、基本块、SSA形式、类型系统和常见语法,帮助新手理解LLVM编译流程中的关键层。

2026.09.30

20

12

PDF转图片方法
PDF转图片方法

需要把 PDF 页面用于上传、预览、分享或图片归档时,PDF 转图片方法专题整理 JPG/PNG 格式选择、逐页导出、清晰度设置、批量下载和结果检查等流程,帮助用户稳定完成 PDF 图片化处理。

2026.09.30

20

26

PixTV AI视频生成与无限画布创作
PixTV AI视频生成与无限画布创作

PixTV专题整理AI视频与视觉内容创作相关功能使用教程,涵盖AI生图、视频生成、无限画布、多模型创作、素材管理、声音音乐及视频剪辑等功能,帮助用户快速掌握PixTV从创意到成片的完整制作方法。

2026.09.29

20

15

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

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

2026.09.23

240

15

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

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

2026.09.23

140

15

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

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

2026.09.23

120

15

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

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

2026.09.22

60

12

热门下载

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

精品课程

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