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 允许按项目习惯调整字段顺序和占位符,靠修改用户配置实现:

星月写作
星月写作

专为网络小说、 剧本创作者打造的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,别依赖全自动。

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

191

2026.02.25

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

455

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

546

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

334

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

82

2025.09.10

string转int
string转int

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

1010

2023.08.02

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

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

562

2023.09.20

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

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

3

2026.03.11

热门下载

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

精品课程

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

共137课时 | 13.3万人学习

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

共6课时 | 11.3万人学习

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

共13课时 | 1.0万人学习

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

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