0

0

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

冰火之心

冰火之心

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

|

444人浏览过

|

来源于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 支持(如 JavaScriptPHPPython 默认支持,VueTSX 需额外配置)
  • 当前文件语法必须正确识别:右下角状态栏应显示 JavaScript 而不是 Plain Text;点一下切换,或用 Ctrl+Shift+PSet Syntax: JavaScript
  • 不能在字符串、注释块内部、缩进过深的嵌套里敲 /**
  • 确认设置了快捷键:默认是 Tab,不是 EnterSpace

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

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

UP简历
UP简历

基于AI技术的免费在线简历制作工具

下载
  • 菜单栏 → PreferencesPackage SettingsDocBlockrSettings – 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 PackageDocBlockr;还不行就手动补全 @param,别依赖全自动。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

751

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

636

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

758

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

618

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1262

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

547

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

577

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

706

2023.08.11

Java 桌面应用开发(JavaFX 实战)
Java 桌面应用开发(JavaFX 实战)

本专题系统讲解 Java 在桌面应用开发领域的实战应用,重点围绕 JavaFX 框架,涵盖界面布局、控件使用、事件处理、FXML、样式美化(CSS)、多线程与UI响应优化,以及桌面应用的打包与发布。通过完整示例项目,帮助学习者掌握 使用 Java 构建现代化、跨平台桌面应用程序的核心能力。

34

2026.01.14

热门下载

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

精品课程

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

共137课时 | 8.6万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 7万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号