VSCode 添加自定义注释的方法(附带红色警戒经典注释风格)


Posted in Javascript onAugust 27, 2020

如何设置一个自定义注释

整洁的代码和注释风格总是给人一种眼前一亮、赏心悦目的感觉,同时详细的注释也是程序员所必须的职业素养之一
今天主要分享一下如何在VS Code中设置自定义 注释

第一步:

使用ctrl + shift + p 调出如下窗口,并且输入snippets

VSCode 添加自定义注释的方法(附带红色警戒经典注释风格)

第二步:进入json文件编辑

这里以自定义js注释为例:

VSCode 添加自定义注释的方法(附带红色警戒经典注释风格)

进入到 json 文件中后,添加如下代码,大家可以自定义设计,保存退出 我这里是一个类注释 一个方法注释

"Print to js class": {
    "prefix": "zhushiclass",
    "body": [
      "/*",
      " *@Description: $0",
      " *@ClassAuthor: Tian Qin",
      " *@Date: ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE} ${CURRENT_HOUR}:${CURRENT_MINUTE}:${CURRENT_SECOND}",
      "*/"
    ],
  },
  "Print to js method": {
    "prefix": "zhushimethod",
    "body": [
      "/*",
      " *@Description: $0",
      " *@MethodAuthor: HeLihui",
      " *@Date: ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE} ${CURRENT_HOUR}:${CURRENT_MINUTE}:${CURRENT_SECOND}",
      "*/"
    ],
  },

第三步:

保存退出后,我们可以在js文件中看到智能提示

VSCode 添加自定义注释的方法(附带红色警戒经典注释风格)

点击之后会自动生成注释 ,同时date会自动生成

VSCode 添加自定义注释的方法(附带红色警戒经典注释风格)

注意一下,这里html注释稍有不同
因为html注释格式为 < - - ! - - >

"Print to html method": {
    "prefix": "zhushihtml",
    "body": [
			"<!-- ",
      "**@Description: $0",
			"-->"
    ],
  },

最后想分享一下红色警戒的源码 注释的格式 ,在红色警戒的源码公开之后,他的注释简直堪称经典
我整理了一下这段注释,致敬经典!

"Print to js api": {
    "prefix": "hongsejingjie",
    "body": [
      "/***************************************************************************************************",
      " * AircraftClass :: $0                                        *",
      " *        @Description: $0                                 *",
      " *        @Description: $0                                 *",
      " *        @Description: $0                                 *",
      " *                                                 *",
      " * INPUT:$0                                            *",
      " *                                                 *",
      " * OUTPUT:$0                                            *",
      " *                                                 *",
      " * WARNINGS:$0                                           *",
      " * HISTORY:                                            *",
      " *     @MethodAuthor: HeLihui                                 *",
      " *     @Date: ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE} ${CURRENT_HOUR}         *",
      "*==================================================================================================*/"
    ],
  },

VSCode 添加自定义注释的方法(附带红色警戒经典注释风格)
VSCode 添加自定义注释的方法(附带红色警戒经典注释风格)

由于这是我自己整理出来的,所以效果不是很好,所以大家请见谅,也希望大家能够继续完善

VSCode 添加自定义注释的方法(附带红色警戒经典注释风格)

总结

到此这篇关于VSCode 添加自定义注释(附带红色警戒经典注释风格)的文章就介绍到这了,更多相关VSCode 添加自定义注释内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!

Javascript 相关文章推荐
jQuery之ajax删除详解
Feb 27 Javascript
JavaScript获取路径设计源码
May 22 Javascript
原生js实现ajax方法(超简单)
Sep 20 Javascript
bootstrap侧边栏圆点导航
Jan 11 Javascript
webpack打包并将文件加载到指定的位置方法
Feb 22 Javascript
vue的全局提示框组件实例代码
Feb 26 Javascript
JavaScript实现的简单加密解密操作示例
Jun 01 Javascript
JS实现获取数组中最大值或最小值功能示例
Mar 02 Javascript
vue使用自定义指令实现拖拽
Jan 29 Javascript
angular异步验证防抖踩坑实录
Dec 01 Javascript
浅谈element中InfiniteScroll按需引入的一点注意事项
Jun 05 Javascript
代码解析React中setState同步和异步问题
Jun 03 Javascript
js实现弹幕飞机效果
Aug 27 #Javascript
jQuery编写QQ简易聊天框
Aug 27 #jQuery
jQuery实现简单QQ聊天框
Aug 27 #jQuery
js实现前端界面导航栏下拉列表
Aug 27 #Javascript
selenium 反爬虫之跳过淘宝滑块验证功能的实现代码
Aug 27 #Javascript
JS实现拖拽元素时与另一元素碰撞检测
Aug 27 #Javascript
js实现QQ邮箱邮件拖拽删除功能
Aug 27 #Javascript
You might like
PHP二维数组去重算法
2016/12/17 PHP
javascript Onunload与Onbeforeunload使用小结
2009/12/31 Javascript
JavaScript mapreduce工作原理简析
2012/11/25 Javascript
js call方法详细介绍(js 的继承)
2013/11/18 Javascript
js中for in的用法示例解析
2013/12/25 Javascript
js关于精确计算和数值格式化以及直接引js文件
2014/01/28 Javascript
IE6浏览器中window.location.href无效的解决方法
2014/11/20 Javascript
js判断手机和pc端选择不同执行事件的方法
2015/01/30 Javascript
基于jQuery和CSS3制作数字时钟附源码下载(jquery篇)
2015/11/24 Javascript
fckeditor部署到weblogic出现xml无法读取及样式不能显示问题的解决方法
2017/03/24 Javascript
vue高德地图之玩转周边
2017/06/16 Javascript
vue文件树组件使用详解
2018/03/29 Javascript
vue使用自定义icon图标的方法
2018/05/14 Javascript
vue-cli 首屏加载优化问题
2018/11/06 Javascript
OpenLayers3实现地图显示功能
2020/09/25 Javascript
[02:43]2018DOTA2亚洲邀请赛主赛事首日TOP5
2018/04/04 DOTA
[55:11]完美世界DOTA2联赛PWL S2 SZ vs LBZS 第一场 11.26
2020/11/30 DOTA
Python中import导入上一级目录模块及循环import问题的解决
2016/06/04 Python
详解django中自定义标签和过滤器
2017/07/03 Python
python 处理string到hex脚本的方法
2018/10/26 Python
Python3视频转字符动画的实例代码
2019/08/29 Python
PyQt5 控件字体样式等设置的实现
2020/05/13 Python
Python中的wordcloud库安装问题及解决方法
2020/05/27 Python
PyCharm配置anaconda环境的步骤详解
2020/07/31 Python
Python爬虫+tkinter界面实现历史天气查询的思路详解
2021/02/22 Python
怎样创建、运行java程序
2014/08/01 面试题
int *p=NULL和*p= NULL有什么区别
2014/10/23 面试题
2014年应届大学生毕业自我鉴定
2014/01/31 职场文书
房地产活动策划方案
2014/05/14 职场文书
李开复演讲稿
2014/05/24 职场文书
债务纠纷委托书
2014/08/30 职场文书
房屋分割离婚协议书范本
2014/12/01 职场文书
答谢词范文
2015/01/05 职场文书
转正申请报告格式
2015/05/15 职场文书
奶茶店的创业计划书该怎么写?
2019/07/15 职场文书
一文搞懂PHP中的抽象类和接口
2022/05/25 PHP