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

Sublime Text DocBlockr怎么用_Sublime Text注释生成器教程【技巧】

梦墨小哥_4233

梦墨小哥_4233

发布时间:2026-03-28 15:51:31

|

283人浏览过

|

来源于php中文网

原创

DocBlockr 的 /** 触发失效通常因光标位置错误或语法模式不匹配,需确保在支持语言(如 JavaScript)的函数声明行开头触发,且状态栏显示正确语法类型。

sublime text docblockr怎么用_sublime text注释生成器教程【技巧】

DocBlockr 的 /** 触发失效了怎么办

不是插件坏了,大概率是光标位置或语法模式没对上。DocBlockr 只在支持的语法(比如 JavaScriptPHPPython)下监听 /** 回车,且要求光标紧贴函数/变量声明行的开头或正上方。

  • 确认右下角状态栏显示的是 JavaScript 而不是 Plain Text —— 点击它手动切换
  • 光标必须在函数定义行的任意位置(如 function foo() { 这一行),不能在空行或注释行
  • 如果用了 TypeScript,需额外安装 DocBlockr for TypeScript,原版不识别 interfaceconst 声明
  • 某些自定义构建的语法高亮包会覆盖默认作用域,可临时禁用其他插件排查

生成的注释里参数类型老是空着,怎么填 @param

DocBlockr 不自动推断类型,它只按函数签名里的形参名生成占位符,类型得你手动补全或靠编辑器语义支持联动。

  • 写完 /** 回车后,Tab 键可在各个 @param 字段间跳转,直接输入类型(如 {string})和描述
  • JavaScript 中开启 jsdoc_parse_types 配置项,能从 JSDoc 注释里提取类型(但不适用于运行时动态结构)
  • 如果用 VS Code 习惯了自动补全,别指望 DocBlockr 有同等级智能 —— 它本质是模板引擎,不是语言服务器
  • 注意 @param 后面跟的是花括号包裹的类型,不是尖括号:@param {number} count ✅,@param <number> count</number>

为什么 @return 没自动出现,或者类型写错了

DocBlockr 默认只对带 return 关键字的函数体尝试推断返回类型,且仅限简单字面量(如 return "ok"{string}),复杂逻辑一律留空。

  • 函数没有显式 return 语句(比如只调用其他函数),@return 就不会生成
  • 箭头函数单表达式体(=> "ok")能识别,但多语句块(=> { return "ok" })常被忽略
  • 想强制加 @return,可在触发注释后按 Ctrl+Shift+P(Windows/Linux)或 Cmd+Shift+P(macOS),输入 DocBlockr: Add @return
  • 返回 Promise 时,它不会自动展开泛型 —— {Promise<string>}</string> 得自己敲,别等它补全

自定义模板让 @author 和日期自动填入

默认模板不包含作者和时间,但 Sublime Text 允许通过用户配置覆盖。关键不是改插件源码,而是改 Preferences.sublime-settings 里的 jsdocs_extra_tags 和模板变量。

  • 打开 Preferences → Package Settings → DocBlockr → Settings – User
  • 加入这段配置:
    {
      "jsdocs_extra_tags": [
        ["@author", "Your Name"],
        ["@date", "$date"]
      ],
      "jsdocs_indentation_spaces": 2
    }
    
  • $date 会被替换成当前日期(格式如 2024-05-22),但不支持自定义格式;要改就得改插件 Python 文件里的 datetime.now().strftime(...)
  • 多个 @author 用数组项追加,别试图在一条里写逗号分隔 —— 插件会当一个字符串处理
DocBlockr 的边界很清晰:它不分析 AST,不连接 LSP,也不适配所有 JS 框架的装饰器语法。真正卡住的时候,往往不是配置没调对,而是你把它当成了类型检查工具在用。

热门AI工具

更多
讯飞智作

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

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

Laper
Laper Hot

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

豆包大模型

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

DeepSeek

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

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

WorkBuddy

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

相关专题

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

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

232

2026.02.13

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

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

460

2026.02.25

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

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

311

2026.03.13

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

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

226

2026.06.03

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

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

438

2026.06.16

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

5059

2023.08.02

counta和count的区别
counta和count的区别

Count函数用于计算指定范围内数字的个数,而CountA函数用于计算指定范围内非空单元格的个数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2288

2023.11.20

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

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

1898

2023.09.20

Vibeknow在线使用入口合集
Vibeknow在线使用入口合集

本专题汇总了Vibeknow在线创作视频的官方入口及网页版使用教程,涵盖PPT、PDF、Word等文档一键转讲解视频的核心操作,并整理了免费版水印规则与手机端浏览器访问指南,助你快速将知识内容视频化。

0

2026.09.21

热门下载

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

精品课程

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

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