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)生成注释块,但必须光标停在函数定义行上方(空行或紧贴函数声明前)。

绘蛙
绘蛙

电商场景的AI创作平台,无需高薪聘请商拍和文案团队,使用绘蛙即可低成本、批量创作优质的商拍图、种草文案

下载
  • 支持的函数声明格式包括: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,修改以下字段:

{
    "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 文件。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

47

2026.02.13

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

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

193

2026.02.25

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

562

2023.09.20

class在c语言中的意思
class在c语言中的意思

在C语言中,"class" 是一个关键字,用于定义一个类。想了解更多class的相关内容,可以阅读本专题下面的文章。

871

2024.01.03

python中class的含义
python中class的含义

本专题整合了python中class的相关内容,阅读专题下面的文章了解更多详细内容。

30

2025.12.06

js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

530

2023.06.20

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

576

2023.07.28

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

760

2023.08.03

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

76

2026.03.11

热门下载

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

精品课程

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

共48课时 | 10.6万人学习

Git 教程
Git 教程

共21课时 | 4.2万人学习

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

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