0

0

sublime怎么快速生成注释块_sublime使用DocBlockr插件写文档

冰火之心

冰火之心

发布时间:2025-11-22 13:23:02

|

879人浏览过

|

来源于php中文网

原创

安装DocBlockr插件后,在函数上方输入/**并回车,即可自动生成包含@param、@return等标签的结构化注释块,支持多种语言并可自定义配置提升效率。

sublime怎么快速生成注释块_sublime使用docblockr插件写文档

在 Sublime Text 中快速生成注释块,可以借助 DocBlockr 插件高效编写函数或类的文档注释。安装并配置后,只需简单操作就能自动生成结构化的注释块,提升代码可读性和开发效率。

安装 DocBlockr 插件

使用 Package Control 安装 DocBlockr 是最便捷的方式:

  • 按下 Ctrl+Shift+P(Mac 上是 Cmd+Shift+P)打开命令面板
  • 输入 "Install Package" 并选择对应选项
  • 搜索 "DocBlockr",点击安装即可

快速生成注释块的方法

安装完成后,在函数上方输入 /** 然后回车,DocBlockr 会自动解析函数参数、返回值等信息,生成标准注释块。

ClippingMagic
ClippingMagic

魔术般地去除图片背景

下载
  • 在 JavaScript、PHP、Python 等语言中均支持自动提取参数名和类型
  • 例如在 PHP 中写 function test($name, $age),在其上方输入 /** 回车,会自动生成包含 @param 的注释
  • 支持 @return、@author、@version 等常用标签自动填充

常用技巧与设置

进一步提升使用体验,可以调整插件设置:

  • 通过 Preferences → Package Settings → DocBlockr → Settings 查看和修改配置
  • 启用 "jsdocs_extra_tags" 添加常用标签如 @since 或 @example
  • 设置 "jsdocs_extend_name" 控制注释对齐风格
  • 输入 /** + tab 可快速触发补全(部分版本支持)

基本上就这些,配合语法高亮和缩进设置,DocBlockr 能让 Sublime Text 的文档编写变得非常顺畅。

相关专题

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

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

745

2023.06.15

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

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

634

2023.07.20

python能做什么
python能做什么

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

757

2023.07.25

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

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

617

2023.07.31

python教程
python教程

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

1259

2023.08.03

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

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

547

2023.08.04

python eval
python eval

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

577

2023.08.04

scratch和python区别
scratch和python区别

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

705

2023.08.11

c++主流开发框架汇总
c++主流开发框架汇总

本专题整合了c++开发框架推荐,阅读专题下面的文章了解更多详细内容。

25

2026.01.09

热门下载

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

精品课程

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

共137课时 | 8.5万人学习

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

共6课时 | 6.9万人学习

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

共13课时 | 0.8万人学习

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

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