0

0

sublime怎么安装DocBlockr插件_sublime快速生成函数注释【教程】

裘德小鎮的故事

裘德小鎮的故事

发布时间:2026-01-22 16:47:55

|

325人浏览过

|

来源于php中文网

原创

Sublime Text需通过Package Control安装DocBlockr插件并配置jsdocs_auto_add_method_tag等选项才能自动生成含@param的函数注释,手动安装易失效,且要求语法识别正确、快捷键未冲突、Sublime版本≥3148。

sublime怎么安装docblockr插件_sublime快速生成函数注释【教程】

Sublime Text 本身不自带 DocBlockr,但可以通过 Package Control 正确安装并立即生效——前提是别选错包名,也别手动下载 ZIP 解压到错误目录。

用 Package Control 安装 DocBlockr(推荐)

这是唯一稳定、可更新的方式。手动放文件夹容易因路径错误或版本不匹配导致 ctrl+alt+D 没反应。

  • 确保已安装 Package Control:按 Ctrl+Shift+P(Win/Linux)或 Cmd+Shift+P(macOS),输入 Install Package Control 并回车(如未安装)
  • 再次调出命令面板,输入 Package Control: Install Package 回车
  • 等待列表加载完成,输入 DocBlockr(注意拼写,不是 DocBlockDoxygen
  • 选择并回车,几秒后右下角会提示 Successfully installed DocBlockr

安装后怎么用函数注释快捷键

DocBlockr 默认绑定 ctrl+alt+D(Windows/Linux)或 cmd+alt+D(macOS)生成注释块,但必须光标停在函数定义行上方(空行或紧贴函数声明前)。

  • 支持的函数声明格式包括:function name() {const fn = () => {}class A { method() {} }def method(self):(Python)
  • 如果光标在函数体内或参数行,会生成空的 /** */,不会自动提取参数名
  • 想让参数自动填充,需开启 jsdocs_auto_add_method_tagjsdocs_include_author 等设置(见下一条)

关键配置项要改,否则注释很简陋

默认配置几乎不填 @param@return,看起来像没生效。打开 Preferences → Package Settings → DocBlockr → Settings,修改以下字段:

星辰Agent
星辰Agent

科大讯飞推出的智能体Agent开发平台,助力开发者快速搭建生产级智能体

下载
{
    "jsdocs_auto_add_method_tag": true,
    "jsdocs_auto_add_default_values": true,
    "jsdocs_spacer_between_sections": true,
    "jsdocs_indentation_spaces": 4,
    "jsdocs_extra_tags": [
        "@author",
        "@version"
    ]
}
  • jsdocs_auto_add_method_tag 控制是否加 @method 标签(JS 类方法需要)
  • jsdocs_auto_add_default_values 决定是否从 function(a = 1, b) 中提取默认值写进 @param
  • 如果项目用 TypeScript,建议额外加 "jsdocs_parse_param_description": true 来解析 JSDoc 注释里的类型描述

常见失效原因和排查点

装完没反应?大概率是这几个地方卡住了:

  • 当前文件没有正确识别语法:检查右下角是否显示 JavaScript / Python,不是 Plain text;可手动点击切换
  • 快捷键被其他插件占用:在 Preferences → Key Bindings 中搜索 docblockr,确认 ctrl+alt+D 绑定的是 doc_blockr 命令
  • 函数体用了箭头函数且无花括号:const a = () => 1 不会被识别,必须写成 const a = () => { return 1; }
  • Sublime 版本太老:DocBlockr 要求 Sublime Text 3 build 3148+,旧版可能报 ImportError: No module named 'urllib.parse'

真正麻烦的不是安装,而是配置里那几个布尔开关——关着时生成的注释看着像占位符,开着才真正省时间。别跳过 Settings 文件。

相关专题

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

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

771

2023.06.15

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

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

661

2023.07.20

python能做什么
python能做什么

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

764

2023.07.25

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

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

659

2023.07.31

python教程
python教程

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

1345

2023.08.03

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

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

549

2023.08.04

python eval
python eval

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

579

2023.08.04

scratch和python区别
scratch和python区别

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

730

2023.08.11

Golang 性能分析与pprof调优实战
Golang 性能分析与pprof调优实战

本专题系统讲解 Golang 应用的性能分析与调优方法,重点覆盖 pprof 的使用方式,包括 CPU、内存、阻塞与 goroutine 分析,火焰图解读,常见性能瓶颈定位思路,以及在真实项目中进行针对性优化的实践技巧。通过案例讲解,帮助开发者掌握 用数据驱动的方式持续提升 Go 程序性能与稳定性。

8

2026.01.22

热门下载

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

精品课程

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

共48课时 | 7.6万人学习

Git 教程
Git 教程

共21课时 | 2.9万人学习

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

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