0

0

sublime的DocBlockr插件怎么用_sublime DocBlockr插件使用教程

穿越時空

穿越時空

发布时间:2025-10-12 14:37:02

|

190人浏览过

|

来源于php中文网

原创

安装并使用DocBlockr插件可快速生成标准文档注释。1. 通过Package Control搜索安装DocBlockr;2. 在函数或类上方输入/**后回车,自动解析代码生成注释;3. 支持JavaScript、PHP等多种语言,输入@可触发标签补全;4. 可自定义配置添加作者、版本等信息,提升注释效率与代码规范性。

sublime的docblockr插件怎么用_sublime docblockr插件使用教程

DocBlockr 是 Sublime Text 中非常实用的代码注释插件,能帮助开发者快速生成函数、类、变量等的文档注释(如 JSDoc、PHPDoc 等)。安装后只需简单操作即可自动生成结构清晰的注释块,提高代码可读性和维护性。

1. 安装 DocBlockr 插件

使用 Package Control 安装是最简单的方式:

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

安装完成后无需重启,直接在代码中使用。

2. 基本使用方法

在函数或类上方输入 /** 然后回车,DocBlockr 会自动解析下方代码并生成对应注释。

例如,在 JavaScript 中:

/**
 * @param {string} name
 * @param {number} age
 * @returns {boolean}
 */
function createUser(name, age) {
    // ...
}

输入 /** 并回车后,插件会自动提取参数名、类型(若能推断),并生成标准格式注释。

易优乐器古筝书画培训类网站源码1.6.9
易优乐器古筝书画培训类网站源码1.6.9

易优乐器古筝书画培训类网站源码是基于易优cms开发,适合企业进行教育培训展示使用。程序内核为Thinkphp5.0开发,后台简洁,为企业网站而生。 这是一套安装就能建站的程序,不定期更新程序BUG,更新网站功能。 我们提供的不仅是模板这么简单,我们还提供程序相关咨询、协助安装等服务。 默认不包含小程序插件,需要另外单独购买插件。 模板安装步骤 1、请将安装包Z

下载

3. 支持的语言与标签自动补全

DocBlockr 支持多种语言,包括:

  • JavaScript / TypeScript
  • PHP
  • Python
  • Java
  • C++ / C#

输入 @ 后会弹出可用标签提示,如 @param@return@author@version 等。按 Tab 可快速填写字段。

4. 自定义配置(可选)

可通过设置添加作者信息、默认描述等:

  • 进入菜单:Preferences → Package Settings → DocBlockr → Settings - User
  • 添加如下配置示例:
{
    "jsdocs_extra_tags": [
        "@author John Doe",
        "@version 1.0.0"
    ],
    "jsdocs_extend_name": true,
    "jsdocs_spacer_between_sections": true
}

这样每次生成注释时会自动包含作者和版本信息。

基本上就这些。熟练使用 DocBlockr 能大幅提升写注释效率,让代码更专业。不复杂但容易忽略细节,比如参数类型推断依赖命名规范,建议配合良好的编码习惯使用。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2644

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1656

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1513

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

952

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1418

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1234

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1448

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1306

2023.11.13

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

68

2026.01.16

热门下载

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

精品课程

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

共137课时 | 8.8万人学习

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

共6课时 | 7.9万人学习

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

共13课时 | 0.9万人学习

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

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