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 相关文章推荐
Ajax::prototype 源码解读
Jan 22 Javascript
JavaScript 空位补零实现代码
Feb 26 Javascript
JavaScript学习点滴 call、apply的区别
Oct 22 Javascript
JS实现带鼠标效果的头像及文章列表代码
Sep 27 Javascript
Form表单按回车自动提交表单的实现方法
Nov 18 Javascript
基于jQuery实现左侧菜单栏可折叠功能
Dec 27 Javascript
在iframe中使bootstrap的模态框在父页面弹出问题
Aug 07 Javascript
angular4自定义组件详解
Sep 28 Javascript
JavaScript数据结构之栈实例用法
Jan 18 Javascript
小程序绑定用户方案优化小结
May 15 Javascript
layer.open提交子页面的form和layedit文本编辑内容的方法
Sep 27 Javascript
Paypal支付不完全指北
Jun 04 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下使用curl模拟用户登陆的代码
2010/09/10 PHP
php array_map()数组函数使用说明
2011/07/12 PHP
php对mongodb的扩展(初出茅庐)
2012/11/11 PHP
详解在PHP的Yii框架中使用行为Behaviors的方法
2016/03/18 PHP
php技巧小结【推荐】
2017/01/19 PHP
使用PHPStorm+XDebug搭建单步调试环境
2017/11/19 PHP
070823更新的一个[消息提示框]组件 兼容ie7
2007/08/29 Javascript
JS IE和FF兼容性问题汇总
2009/02/09 Javascript
使弱类型的语言JavaScript变强势
2009/06/22 Javascript
js中的window.open返回object的错误的解决方法
2009/08/15 Javascript
基于Jquery的跨域传输数据(JSONP)
2011/03/10 Javascript
JavaScript 判断浏览器是否支持SVG的代码
2013/03/21 Javascript
关于JQuery($.load)事件的用法和分析
2013/04/09 Javascript
javascript操作excel生成报表全攻略
2014/05/04 Javascript
浅析Bootstrap缩略图组件与警示框组件
2016/04/29 Javascript
js实现固定宽高滑动轮播图效果
2017/01/13 Javascript
详解nodejs中的process进程
2017/03/19 NodeJs
javascript回调函数的概念理解与用法分析
2017/05/27 Javascript
详解VueRouter进阶之导航钩子和路由元信息
2017/09/13 Javascript
Angular搜索 过滤 批量删除 添加 表单验证功能集锦(实例代码)
2017/10/25 Javascript
JavaScript创建对象的常用方式总结
2018/08/10 Javascript
Vue+axios+WebApi+NPOI导出Excel文件实例方法
2019/06/05 Javascript
vue history 模式打包部署在域名的二级目录的配置指南
2019/07/02 Javascript
js判断浏览器的环境(pc端,移动端,还是微信浏览器)
2020/12/24 Javascript
[03:14]2014DOTA2西雅图国际邀请赛 EG战队巡礼
2014/07/07 DOTA
python获得文件创建时间和修改时间的方法
2015/06/30 Python
Python实现文件内容批量追加的方法示例
2017/08/29 Python
python 叠加等边三角形的绘制的实现
2019/08/14 Python
Django stark组件使用及原理详解
2019/08/22 Python
python3 selenium自动化 frame表单嵌套的切换方法
2019/08/23 Python
python树的同构学习笔记
2019/09/14 Python
详解python3类型注释annotations实用案例
2021/01/20 Python
惠普墨西哥官方商店:HP墨西哥
2016/12/01 全球购物
原告代理词范文
2015/05/25 职场文书
雷锋之歌观后感
2015/06/10 职场文书
pytorch常用数据类型所占字节数对照表一览
2021/05/17 Python