0

0

sublime如何利用DocBlockr插件快速生成注释文档?(规范编写)

裘德小鎮的故事

裘德小鎮的故事

发布时间:2026-03-12 10:10:04

|

201人浏览过

|

来源于php中文网

原创

docblockr按tab无反应的根本原因是触发范围错误:仅在函数/类定义行上方空行或定义行开头才生效,变量、语句、注释中均不触发,且需检查快捷键是否被emmet等插件劫持。

sublime如何利用docblockr插件快速生成注释文档?(规范编写)

DocBlockr 插件安装后为什么按 Tab 没反应?

根本原因通常是触发范围没对上:DocBlockr 只在函数、类、方法定义行上方的空行或紧贴定义行的位置,按 Tab 才会生成注释块。它不识别变量、普通语句或注释中间。

  • 确保光标停在函数声明正上方的空行,或直接放在 function / def / class 那一行的开头(如 function foo() {
  • JavaScript 中需写全 function 关键字;箭头函数 const foo = () => {} 默认不触发,得手动输入 /** 再按 Tab
  • Python 要求函数/类定义语法正确,且缩进无误;如果光标在 def foo(): 行末尾,Tab 也能触发,但在行中任意位置可能失效
  • 检查是否被其他插件劫持了 Tab 快捷键(比如 Emmet),可在 Preferences → Key Bindings 搜索 docblockr 确认绑定是否存在

如何让 DocBlockr 生成符合 JSDoc / PHPDoc 规范的参数描述?

它默认能解析常见语言的函数签名,但依赖格式清晰、无歧义。参数名和类型必须显式可读,否则会漏掉或填错 @param

  • JavaScript 示例:function getUser(id, options) { → 会生成两个 @param,但不会自动推断类型;若写成 function getUser(/** @type {number} */ id, /** @type {Object} */ options) {,DocBlockr 仍只取变量名,类型得手补
  • PHP 中 public function find($id, $with = []) 会被识别为两个参数,$with = [] 的默认值不会自动转成 @param array $with [optional],需后续手动加
  • Python 的 def process(data: list, timeout: int = 30) 能提取 datatimeout,但类型提示仅作参考,不会自动写进 @param{list} 里,得自己补
  • 想强制补全类型,可在生成后快速用 Ctrl+Shift+PDocBlockr: Expand Abbreviation(部分版本支持),或直接敲 @param 后按 Tab 补默认模板

自定义模板时 docblockr.sublime-settings 哪些字段最常改?

多数人卡在改了设置不生效——因为 Sublime 的 package settings 加载优先级高,用户级配置必须放在 Preferences → Package Settings → DocBlockr → Settings – User,且不能有语法错误。

Article Forge
Article Forge

行业文案AI写作软件,可自动为特定主题或行业生成内容

下载
  • "jsdoc_extra_tags":追加常用标签,比如加 "@since": """@deprecated": "",避免每次手打
  • "jsdoc_indentation":设为 24 控制注释内缩进,不匹配项目风格会导致 ESLint 报 jsdoc/indent 错误
  • "jsdoc_parse_param_description":设为 true 后,它会尝试从函数体第一行注释(如 // id: user ID string)提取参数说明,但准确率一般,慎开
  • PHP/Python 模板单独用 "phpdoc_..." / "pydoc_..." 前缀字段控制,混用 JS 设置无效

为什么生成的注释里 @return 总是 {void}

DocBlockr 不分析函数体逻辑,只看语言层面的返回关键词是否存在。它看到 return 就写 @return,但类型全靠猜;没看到显式 return 就默认 void

  • JavaScript 中 function calc() { if (x) return 1; } 会被判为可能无返回,仍标 @return {void};得手动改成 @return {(number|undefined)}
  • PHP 的 function test() { return $this->data ?? null; } 无法推断 $this->data 类型,@return 留空或写 @return mixed 更稳妥
  • Python 的 return 语句若带类型注解(-> str:),DocBlockr 不读这个,所以 @return 字段仍为空,得补全
  • 别依赖它填准 @return,把它当占位符,生成后立刻检查并修正类型——这是最容易被跳过、也最影响下游工具(如 TypeScript 生成、IDE 跳转)的一环

实际用起来,最常被忽略的是函数签名的“可解析性”:哪怕只多一个括号不匹配、少一个冒号,DocBlockr 就放弃推导,静默退化成空模板。与其反复调参数,不如先保证定义本身干净。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

阿里巴巴推出的全能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 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

192

2026.02.25

string转int
string转int

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

1010

2023.08.02

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

254

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

1089

2024.03.01

if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

846

2023.08.22

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

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

562

2023.09.20

string转int
string转int

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

1010

2023.08.02

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

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

3

2026.03.11

热门下载

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

精品课程

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

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