sublime 添加注释模块

问题背景:

规范的程序需要对函数进行注释,常用的开发工具如IDEA、VS Code都对注释模板有很好的支持。本博客介绍Sublime下支持模块注释功能的设置。

一 安装

一、安装方法
1.安装docblocker插件

    mac  Cmd+Shift+P -> Install Package -> docblockr 

    win   Ctrl+Shift+P -> Install Package -> docblockr 

step 1:Install Package

进入控制台,然后输入install,选择下面的package,

点击Install Package,系统为自动安装

 左下角安装进度如下,loading ...  ...

经过上一步回车后到达第二步(可能需要等待一会儿),会出现搜索框,搜索DocBlockr 回车进行安装

step 2:Install docblockr 

同上,继续等待一会系统安装。

2.配置

    Preference -> Package Settings -> DocBlockr -> Settings - User

    添加配置内容:

{
    "jsdocs_extra_tags":[

       "@fuction ${1:[description]}",
        "@Author your name",
        "@DateTime {{datetime}}",
        "@copyright ${1:[copyright]}",
        "@license ${1:[license]}",
        "@version ${1:[version]}"
    ],
    "jsdocs_function_description": false
  }

二、使用方法
ctr+N 打开新文件,然后写一个函数,在该函数上面的一行,输入/**,然后按Tab/Enter建,如下显示:

ps:

1、/**是紧贴主函数上面的一行,超过了便无法自动带出如下参数的注释。

2、/**的输入是在main(){}写好的前提下,再输入/** +Tab;

3、main函数也可以用其他函数替代,如function testFunction(a, b, c) {};

二 功能介绍 

1 配置说明

jsdocs_extra_tags表示额外的一些配置,@param、@return属于自带的配置

若想添加额外的设置,在setting-users中添加根据自己的需要配置

2 使用技巧

在注释块中,按@键可以展开关键词

参考链接:

1.原博客 sublime docblockr 插件的自动注释功能_buck198的博客-CSDN博客_docblockr sublime

2.sublime 注释模版插件DocBlockr的使用 - knyel - 博客园

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/341193.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

只读副本和Spring Data第3部分:配置两个实体管理器

我们之前的设置可以正常工作。 我们现在要做的是进一步发展,并配置两个单独的实体管理器,而不会影响我们之前实现的功能。 第一步是将默认的实体管理器配置设置为主要配置。 这是第一步 package com.gkatzioura.springdatareadreplica.config; import…

Win+E快速打开我的电脑方式设置方式

W10运用快捷键WinE快速打开我的电脑设置方式

JMetro版本11.6.5和8.6.5发布

再一次问好。 设置了SDK中所有JavaFX控件的样式以及其他一些不存在的样式以及其他库中的其他样式。 后续版本将涉及调整JMetro现有样式或从第三方库的其他控件添加其他样式。 此版本就是这种情况。 这是新功能: 3种新的控件样式; 调整JMetro现有样式&a…

Chrome浏览器的便捷使用方式

截取转载于B站视频【全套教程】高效玩转Chrome浏览器,丰富你的上网体验_哔哩哔哩_bilibili中的脑图文件,便于之后的熟悉使用。 脑图链接 https://naotu.baidu.com/file/5a5332eee10dd903cc084d49189cd2behttps://naotu.baidu.com/file/5a5332eee10dd90…

Sublime查看已经安装的插件

蓝色框图内显示已经安装的插件

activemq网络桥接_ActiveMQ –经纪人网络解释–第3部分

activemq网络桥接现在,我们已经在本博客系列的第1部分和第2 部分中了解了ActiveMQ网络连接器的基础,在第3部分中,我们将研究ActiveMQ如何平衡连接到代理网络的使用者。 介绍 当可以无序处理队列中的消息时通常使用并发使用者,通常…

Word样式的导入与导出

1 样式的介绍 样式,也就是Word中各级标题的格式。合理的设置样式模板,可以帮助更方便的进行文本编辑。 2 样式的导入 具体情形为将“文档标准模板.dotm”的内容应用于“新建Microsoft Word文档”。 按照图示进行操作 【 如果应用模板为文件内的样式…

word将一个文档的样式导入到另一个文档

一、背景 在word中编辑文档时,经常需要定义一个样式给特定格式的文本使用,如标题1,标题2等,而有时需要在一个新文档A中使用一个旧文档B中定义好的样式。 二、操作步骤 1、打开旧文档B,选择上方标签栏的"样式&quo…

Spring Boot应用程序浪费了内存

内存是当今世界上被广泛浪费的资源之一。 由于编程效率低下,令人吃惊的(有时是“令人震惊的”)内存浪费被浪费了。 我们看到这种模式在多个企业应用程序中重复出现。 为了证明这种情况,我们进行了一项小型研究。 我们分析了著名的…

Win10灵活使用快速访问

I 快速访问视图 位置在winE 左侧窗口,点击可快速到达某个特定的文件夹。作用类似于快捷方式,操作简单。 II 关闭自动添加 默认是显示经常使用的文件夹。这使得窗口内文件夹较乱。 通过以下设置,关闭自动显示 1. 2.把框内√去掉 III 固定文…

activemq网络桥接_ActiveMQ –经纪人网络解释–第2部分

activemq网络桥接在此博客中,我们将看到双工网络连接器如何工作。 在上一部分中,我们从broker-1和broker-2创建了一个网络连接器。 我们能够看到,当代理2上有一个使用者使用队列“ foo.bar”时,代理1上的队列“ foo.bar”的消息如…

Apache Lucene中的并发查询执行

Apache Lucene是一个出色的并发纯Java搜索引擎,如果您愿意,它可以轻松地使服务器上的可用CPU或IO资源饱和。 “典型” Lucene应用程序的并发模型在搜索时每个查询一个线程,但是您知道Lucene还可以使用多个线程同时执行一个查询以大大减少最慢…

Windows设置自己的程序开机自动启动

Windows系统想要快速设置开机自动启动某个程序,可以使用以下方法设置: 1.找到启动文件夹 CtrlR 打开运行,输入shell:startup,回车,找到启动文件夹 2.拷贝需要开机启动的程序的快捷方式到此文件夹即可。 3.打开任务管理器-启动查…

Citavi中文件管理

目录 I 文献相对应的PDF文件相关操作 1 打开PDF所在位置 2 直接重命名PDF文献 注:设置角标方式 II 阅读文献相关的文件的添加与删除 1 添加 2 删除 III PPT CAJ文件的添加 I 文献相对应的PDF文件相关操作 PDF文件可直接拉入文献框进行导入 1 打开PDF所在位置…

Citavi插件的安装和使用以及注意事项

【文章转载于知乎大神:Citavi插件的安装和使用以及注意事项 - 知乎】 没有软件是十全十美的,基础功能够用,附加功能以插件、脚本的方式来支持是个不错的思路。 Citavi提供了自定义宏和插件的方式,来满足更为复杂的格式修整和文献…

MiUI特色功能设置总结

一 常用设置 【转载于知乎https://www.zhihu.com/question/514792652/answer/2377622710】 1 自动优化系统 其实在手机开发者模式设置中,有2个地方我们需要设置,设置了不仅可以让手机运行更流畅,而且还能帮我们自动优化系统。 &#xff0…

potplayer怎么设置无边框播放,播放时隐藏进度条

potplayer默认情况下播放视频时会显示边框,那么怎么设置无边框播放呢?下面小编就为大家详细的介绍一下,大家感兴趣的话就一起来了解下吧! potplayer怎么设置无边框播放?potplayer设置无边框播放方法 1、点击左上角的potplayer 2、在下拉菜单中点击选项…

蓝牙播放Stereo和Hands-Free AG Audio两种模式的区别?

当使用蓝牙耳机时,发现电脑的播放设备显示了两种模式(如下图所示),Stereo模式下声音正常,而调到Hands-Free AG Audio模式下声音频带窄了很多且音质差,典型的电话音,下面具体说说这两种模式的区别…

workrave使用方法

一 模式介绍 阅读模式: 不论电脑什么状态,倒计时一直进行 普通模式: 当检测到电脑没有任何操作,比如打字与移动鼠标,则暂停倒计时。如果长时间没有操作,则默认进入休息状态,下次移动鼠标&…

OpenJDK织机和结构化并发

Project Loom是Hotspot Group赞助的项目之一,旨在向JAVA世界提供高吞吐量和轻量级的并发模型。 在撰写本文时,Loom项目仍处于积极开发中,其API可能会更改。 为什么要织机? 每个新项目可能会出现的第一个问题是为什么?…