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

sublime怎么快速生成注释文档_sublime安装DocBlockr规范注释【教程】

秋墨大大_8820

秋墨大大_8820

发布时间:2026-01-05 15:44:03

|

504人浏览过

|

来源于php中文网

原创

Sublime Text需通过Package Control手动安装DocBlockr插件;安装后在支持语言的函数/类声明正上方输入/**+Tab才能触发注释生成,且文件语法须正确识别为对应语言(如JavaScript)。

sublime怎么快速生成注释文档_sublime安装docblockr规范注释【教程】

Sublime Text 本身不自带 DocBlockr 插件,必须手动安装;装完后 /** + Tab 才能触发文档注释生成,不是所有符号组合都有效。

怎么安装 DocBlockr 插件

DocBlockr 不在 Sublime 默认源里,得用 Package Control 安装:

  • 确保已安装 Package Control(没装的话搜 “Install Package Control” 官方脚本运行一次)
  • Ctrl+Shift+P(Windows/Linux)或 Cmd+Shift+P(macOS)呼出命令面板
  • 输入 Package Control: Install Package 回车
  • 再输入 DocBlockr,选中后回车安装
  • 安装完不用重启,但建议关掉再打开当前文件,让插件识别语言类型

为什么敲 /** 没反应

常见原因不是插件没装好,而是上下文不满足触发条件:

  • 光标必须在函数、类、方法、变量声明的正上方(空行也算),且该语言被 DocBlockr 支持(如 JavaScript、PHP、Python 默认支持,Vue 或 TSX 需额外配置)
  • 当前文件语法必须正确识别:右下角状态栏应显示 JavaScript 而不是 Plain Text;点一下切换,或用 Ctrl+Shift+P → Set Syntax: JavaScript
  • 不能在字符串、注释块内部、缩进过深的嵌套里敲 /**
  • 确认设置了快捷键:默认是 Tab,不是 Enter 或 Space

如何自定义 @param 和 @return 的格式

DocBlockr 允许按项目习惯调整字段顺序和占位符,靠修改用户配置实现:

Expanso json-flatten
Expanso json-flatten

通过 CLI 或 MCP 服务器,使用 Expanso Edge 管道扁平化嵌套 JSON 对象。

下载
  • 菜单栏 → Preferences → Package Settings → DocBlockr → Settings – User
  • 填入类似下面的 JSON(以 JS 为例):
{
  "jsdocs_extra_tags": [
    "@author",
    "@since"
  ],
  "jsdocs_indentation_spaces": 2,
  "jsdocs_spacer_between_sections": true,
  "jsdocs_function_description": true
}

关键点:"jsdocs_function_description" 开启后会在函数名下方自动加一行空描述;"jsdocs_spacer_between_sections" 控制 @param 和 @return 之间是否空行。

常见错误:生成的注释参数名为空或错乱

这是解析失败的典型表现,多见于:

  • 函数使用了箭头函数且没写参数名,例如 const fn = (a, b) => {} 可解析,但 const fn = _ => {} 就无法提取参数
  • 用了解构参数但 DocBlockr 版本太老(v3.15.0+ 才较好支持 ({ a, b }) => {})
  • 函数定义跨多行、有类型注解(如 TypeScript 的 (a: string): number =>),旧版 DocBlockr 会丢参数
  • 当前作用域有同名变量干扰解析(少见,但存在)

遇到这类问题,先升级插件:Package Control: Upgrade Package → DocBlockr;还不行就手动补全 @param,别依赖全自动。

作者最新文章

yandex入口

2026-11-05 16:11

yandex首页

2026-11-05 16:13

Yandex.tm引擎首页

2026-11-05 16:15

Yandex.tm搜索引擎

2026-11-05 16:17

Yandex引擎首页

2026-11-05 16:19

Yandex官网网页版

2026-11-05 16:21

Yandex.tm引擎入口

2026-11-05 16:22

热门AI工具

更多
讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

火山引擎

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

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

WorkBuddy

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

DeepSeek

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

豆包大模型

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

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

Laper
Laper Hot

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

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

312

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

540

2026.02.25

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

391

2026.03.13

TypeScript 全栈开发进阶指南
TypeScript 全栈开发进阶指南

面向有 JavaScript 基础的开发者,深入讲解 TypeScript 的类型系统与全栈开发实践。

306

2026.06.03

TypeScript Node.js 全栈工程化与Monorepo架构实践
TypeScript Node.js 全栈工程化与Monorepo架构实践

本专题围绕 TypeScript 在 Node.js 全栈开发中的工程化实践展开,系统讲解 Monorepo 架构设计、包管理策略、模块复用机制以及服务端与前端统一类型系统的构建方法。通过真实项目案例,帮助开发者提升大型全栈项目的可维护性与协作效率。

718

2026.06.16

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2255

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

3642

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

1216

2023.10.13

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

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

0

2026.11.05

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习

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

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